Skip to content

Commit

Permalink
🎨 Update documentation to include variable naming standards for volum…
Browse files Browse the repository at this point in the history
…es, pressures, voltages, currents, energies, and frequencies
  • Loading branch information
chris-ashe committed Dec 2, 2024
1 parent 3e3f247 commit fd0392a
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion documentation/proc-pages/development/standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,12 @@ Example, the area of the TF winding pack: `a_tf_wp`

---------------------

#### Volumes

- Volumes should start with the `vol_` prefix

---------------------

#### Lengths

- Lengths should start with the `len_` prefix
Expand All @@ -106,12 +112,25 @@ Example, the area of the TF winding pack: `a_tf_wp`

---------------------

#### Pressures

- Pressures should start with the `pres_` prefix

---------------------


#### Densities

- Densities should start with the `den_` prefix

---------------------

#### Voltages

- Voltages should start with the `v_` prefix

---------------------

#### Resistances

- Resistances should start with the `res_` prefix
Expand All @@ -124,6 +143,12 @@ Example, the area of the TF winding pack: `a_tf_wp`

---------------------

#### Currents

- Currents should start with the `amps_` prefix

---------------------

#### Current densities

- Current densities should start with the `j_` prefix
Expand All @@ -136,6 +161,12 @@ Example, the area of the TF winding pack: `a_tf_wp`

---------------------

#### Energies

- Energies should start with the `e_` prefix

---------------------

#### Temperatures

- Temperatures should start with the `temp_` prefix
Expand All @@ -151,7 +182,13 @@ Example, the area of the TF winding pack: `a_tf_wp`

#### Magnetic field strengths

- Magnetic field strengths should start with the `b_prefix`
- Magnetic field strengths should start with the `b_`

---------------------

#### Frequencies

- Frequencies should start with the `hz_`

---------------------

Expand Down

0 comments on commit fd0392a

Please sign in to comment.