Makes doc-string clearer in calculate_sleet_prob

metoppv · Nov 4, 2020 · 27d83b6 · 27d83b6
1 parent 4f59418
commit 27d83b6
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/improver/calculate_sleet_prob.py b/improver/calculate_sleet_prob.py
@@ -45,13 +45,16 @@ def calculate_sleet_probability(prob_of_snow, prob_of_rain):
 
     Args:
       prob_of_snow (iris.cube.Cube):
-        Cube of the probability of snow.
+        Cube of the probability of snow. This can be a fraction (0 <= x <= 1) or
+        categorical (0 or 1)
       prob_of_rain (iris.cube.Cube):
-        Cube of the probability of rain.
+        Cube of the probability of rain. This can be a fraction (0 <= x <= 1) or
+        categorical (0 or 1)
 
     Returns:
       iris.cube.Cube:
-        Cube of the probability of sleet.
+        Cube of the probability of sleet. This will be fractional or categorical,
+        matching the highest precision of the inputs.
 
     Raises:
         ValueError: If the cube contains negative values for the the