Fix comments (#29330)

diff --git a/Resources/Prototypes/Atmospherics/thresholds.yml b/Resources/Prototypes/Atmospherics/thresholds.yml
index bd7df23841f2d91b0b7b7e69ea026241fcdc0975..0730955183ec99f35979ff467e6fc8ea025d9a95 100644 (file)
--- a/Resources/Prototypes/Atmospherics/thresholds.yml
+++ b/Resources/Prototypes/Atmospherics/thresholds.yml
@@ -1,3 +1,12 @@
+# Threshold prototypes for AtmosMonitors
+
+# NOTE: Warning thresholds are given as multipliers of the danger bound. For
+# example, if upperBound=10 (kPa) and upperWarnRound=0.5, that means the upper
+# warning threshold is actually 5 (kPa).
+#
+# As a result, all upperWarn's should be <1 and lowerWarn's should be >1,
+# otherwise the warning will never kick in.
+
 - type: alarmThreshold
   id: stationTemperature
   upperBound: !type:AlarmThresholdSetting
@@ -21,11 +30,7 @@
   lowerWarnAround: !type:AlarmThresholdSetting
     threshold: 1.05 # ~90 kPa
 
-# a reminder that all of these are percentages (where 1 is 100%),
-# so 0.01 is 1%,
-# 0.0001 is 0.01%
-# etc.
-
+# For gas concentrations, threshold=0.1 means 10%
 - type: alarmThreshold
   id: stationOxygen
   lowerBound: !type:AlarmThresholdSetting
@@ -47,6 +52,7 @@
   upperWarnAround: !type:AlarmThresholdSetting
     threshold: 0.5
 
+# this is a hack, but 150% means never danger on water, but warn at 75%
 - type: alarmThreshold
   id: stationWaterVapor
   upperBound: !type:AlarmThresholdSetting