From 4921d0b4715bbdaee3a6820c77cff5611b866b87 Mon Sep 17 00:00:00 2001 From: mn3981 Date: Mon, 17 Mar 2025 11:29:42 +0000 Subject: [PATCH] Add naming conventions for limit variables in documentation --- documentation/proc-pages/development/standards.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/documentation/proc-pages/development/standards.md b/documentation/proc-pages/development/standards.md index 2468eafc18..6b07409ca6 100644 --- a/documentation/proc-pages/development/standards.md +++ b/documentation/proc-pages/development/standards.md @@ -102,6 +102,11 @@ $$ This means the variable represents the fraction of the TF coil area taken up by the winding pack. +!!! note "Naming conventions with limit variables" + + For naming variables which represent either upper or lower limits the words `_max` and `_min` should be used in the variable name. Though if a variable represents the highest of a measured value then the variable name should use the word `_peak`. + + -------------- #### System designations