From fd0392a77b8c33d5d0a537571af86bb982110e7b Mon Sep 17 00:00:00 2001 From: mn3981 Date: Mon, 2 Dec 2024 10:57:22 +0000 Subject: [PATCH] :art: Update documentation to include variable naming standards for volumes, pressures, voltages, currents, energies, and frequencies --- .../proc-pages/development/standards.md | 39 ++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/documentation/proc-pages/development/standards.md b/documentation/proc-pages/development/standards.md index 4e2c7e80..fd8de4d1 100644 --- a/documentation/proc-pages/development/standards.md +++ b/documentation/proc-pages/development/standards.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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_` ---------------------