Meltdown mitigation: rephrased docstring type hinting

Author: kbuc

exercises/concept/meltdown-mitigation/.meta/exemplar.py

@@ -1,8 +1,8 @@
 def is_criticality_balanced(temperature, neutrons_emitted):
     """Verify criticality is balanced.
 
-    :param temperature: Union[int,float] temperature
-    :param neutrons_emitted: Union[int,float] number of neutrons emitted per second
+    :param temperature: temperature value (integer or float)
+    :param neutrons_emitted: number of neutrons emitted per second (integer or float)
     :return:  boolean True if conditions met, False if not
 
     A reactor is said to be critical if it satisfies the following conditions:
@@ -22,9 +22,9 @@ def is_criticality_balanced(temperature, neutrons_emitted):
 def reactor_efficiency(voltage, current, theoretical_max_power):
     """Assess reactor efficiency zone.
 
-    :param voltage: Union[int,float] voltage
-    :param current: Union[int,float] current
-    :param theoretical_max_power: Union[int,float] power that corresponds to a 100% efficiency
+    :param voltage: voltage value (integer or float)
+    :param current: current value (integer or float)
+    :param theoretical_max_power: power that corresponds to a 100% efficiency (integer or float)
     :return: str one of 'green', 'orange', 'red', or 'black'
 
     Efficiency can be grouped into 4 bands:
@@ -57,9 +57,9 @@ def reactor_efficiency(voltage, current, theoretical_max_power):
 def fail_safe(temperature, neutrons_produced_per_second, threshold):
     """Assess and return safety range.
 
-    :param temperature: Union[int,float]
-    :param neutrons_produced_per_second: Union[int,float]
-    :param threshold: Union[int,float]
+    :param temperature: value of the temperature (integer or float)
+    :param neutrons_produced_per_second: neutron flux (integer or float)
+    :param threshold: threshold (integer or float)
     :return: str one of: 'LOW', 'NORMAL', 'DANGER'
 
     - `temperature * neutrons per second` < 40% of `threshold` == 'LOW'

exercises/concept/meltdown-mitigation/conditionals.py

@@ -4,8 +4,8 @@
 def is_criticality_balanced(temperature, neutrons_emitted):
     """Verify criticality is balanced.
 
-    :param temperature: Union[int,float] temperature
-    :param neutrons_emitted: Union[int,float] number of neutrons emitted per second
+    :param temperature: temperature value (integer or float)
+    :param neutrons_emitted: number of neutrons emitted per second (integer or float)
     :return:  boolean True if conditions met, False if not
 
     A reactor is said to be critical if it satisfies the following conditions:
@@ -20,9 +20,9 @@ def is_criticality_balanced(temperature, neutrons_emitted):
 def reactor_efficiency(voltage, current, theoretical_max_power):
     """Assess reactor efficiency zone.
 
-    :param voltage: Union[int,float] voltage
-    :param current: Union[int,float] current
-    :param theoretical_max_power: Union[int,float] power that corresponds to a 100% efficiency
+    :param voltage: voltage value (integer or float)
+    :param current: current value (integer or float)
+    :param theoretical_max_power: power that corresponds to a 100% efficiency (integer or float)
     :return: str one of 'green', 'orange', 'red', or 'black'
 
     Efficiency can be grouped into 4 bands:
@@ -43,9 +43,9 @@ def reactor_efficiency(voltage, current, theoretical_max_power):
 def fail_safe(temperature, neutrons_produced_per_second, threshold):
     """Assess and return safety range.
 
-    :param temperature: Union[int,float] teperature value
-    :param neutrons_produced_per_second: Union[int,float] the electron flux
-    :param threshold: Union[int,float] the threshold value
+    :param temperature: value of the temperature (integer or float)
+    :param neutrons_produced_per_second: neutron flux (integer or float)
+    :param threshold: threshold (integer or float)
     :return: str one of: 'LOW', 'NORMAL', 'DANGER'
 
     - `temperature * neutrons per second` < 40% of `threshold` == 'LOW'