Add include_components to the Args section of the firm docstring

Author: tennlee

src/scores/categorical/multicategorical_impl.py

@@ -76,6 +76,9 @@ def firm(  # pylint: disable=too-many-arguments
         threshold_assignment: Specifies whether the intervals defining the categories are
             left or right closed. That is whether the decision threshold is included in
             the upper (left closed) or lower (right closed) category. Defaults to "lower".
+        include_components: If True, then the function returns the FIRM score
+            along with the overforecast and underforecast penalties as a new dimension
+            called "components". If False (default), then only the FIRM score is returned.
 
     Returns:
         An xarray object with the FIRM score. If `include_components` is true, then
@@ -293,14 +296,14 @@ def seeps(  # pylint: disable=too-many-arguments, too-many-locals
     performance of a forecast across three categories:
 
     - Dry weather (e.g., less than or equal to 0.2mm),
-    - Light precipitation (the climatological lower two-thirds of 
+    - Light precipitation (the climatological lower two-thirds of
       rainfall conditioned on it raining),
-    - Heavy precipitation (the climatological upper one-third of rainfall 
+    - Heavy precipitation (the climatological upper one-third of rainfall
       conditioned on it raining).
 
     The SEEPS penalty matrix is defined as
 
-    
+
     .. math::
         s = \frac{1}{2} \left(
         \begin{matrix}
@@ -310,45 +313,45 @@ def seeps(  # pylint: disable=too-many-arguments, too-many-locals
         \end{matrix}
         \right)
 
-        
-    where 
+
+    where
         - :math:`p_1` is the climatological probability of the dry weather category,
         - :math:`p_3` is the climatological probability of the heavy precipitation category,
         - The rows correspond to the forecast category (dry, light, heavy),
         - The columns correspond to the observation category (dry, light, heavy),
-    
+
     as defined in Eq 15 in Rodwell et al. (2010).
 
     Let :math:`p_2` denote the climatological probability of light precipitation occuring.
     Note that since :math:`p_2 = 2p_3` and :math:`p_1 + p_2 + p_3 = 1`, then :math:`p_3 = (1 - p_1) / 3`
     can be substituted into the penalty matrix. In this implementation, the user only provides
-    :math:`p_1` with the ``prob_dry`` arg and the function calculates :math:`p_3` internally. 
-    Additionally, this  implementation of the score is negatively oriented, meaning that 
-    lower scores are better. 
-    
+    :math:`p_1` with the ``prob_dry`` arg and the function calculates :math:`p_3` internally.
+    Additionally, this  implementation of the score is negatively oriented, meaning that
+    lower scores are better.
+
     Sometimes in the literature, a positively oriented version of SEEPS is used,
     which is defined as :math:`1 - \mathrm{SEEPS}`.
 
-    By default, the scores are only calculated for points where :math:`p_1 \in [0.1, 0.85]` 
+    By default, the scores are only calculated for points where :math:`p_1 \in [0.1, 0.85]`
     as per Rodwell et al. (2010). This can be changed by setting ``mask_clim_extremes`` to ``False`` or
     by changing the ``lower_masked_value`` and ``upper_masked_value`` parameters.
 
     Args:
         fcst: An array of real-valued forecasts (e.g., precipitation forecasts in mm).
         obs: An array of real-valued observations (e.g., precipitation forecasts in mm).
-        prob_dry: The climatological probability of the dry weather category. This is 
+        prob_dry: The climatological probability of the dry weather category. This is
             called :math:`p_1` in the SEEPS penalty matrix. Must be in the range [0, 1].
-        light_heavy_threshold: An array of the rainfall thresholds (e.g., in mm) that separates 
+        light_heavy_threshold: An array of the rainfall thresholds (e.g., in mm) that separates
             light and heavy precipitation. The threshold itself is included in the light
             precipitation category.
         dry_light_threshold: The threshold (e.g., in mm) that separates dry weather from light precipitation.
             Defaults to 0.2. Dry weather is defined as less than or equal to this threshold.
         mask_clim_extremes: If True, mask out the score at points where
             :math:`p_1` is less than ``lower_masked_value`` or greater than ``upper_masked_value``.
             Instead a NaN is returned at these points. Defaults to True.
-        lower_masked_value: The SEEPS score is masked at points where ``prob_dry`` is 
+        lower_masked_value: The SEEPS score is masked at points where ``prob_dry`` is
             less than this value. Defaults to 0.1.
-        upper_masked_value: The SEEPS score is masked at points where ``prob_dry`` is 
+        upper_masked_value: The SEEPS score is masked at points where ``prob_dry`` is
             greater than this value. Defaults to 0.85.
         reduce_dims: Optionally specify which dimensions to reduce when
             calculating the SEEPS score. All other dimensions will be preserved. As a
@@ -374,11 +377,11 @@ def seeps(  # pylint: disable=too-many-arguments, too-many-locals
 
     Warning:
         This function raises a warning if any values in `prob_dry` are exactly equal to 0 or 1.
-    
+
     References:
-        Rodwell, M. J., Richardson, D. S., Hewson, T. D., & Haiden, T. (2010). 
-        A new equitable score suitable for verifying precipitation in numerical 
-        weather prediction. Quarterly Journal of the Royal Meteorological Society, 
+        Rodwell, M. J., Richardson, D. S., Hewson, T. D., & Haiden, T. (2010).
+        A new equitable score suitable for verifying precipitation in numerical
+        weather prediction. Quarterly Journal of the Royal Meteorological Society,
         136(650), 1344–1363. https://doi.org/10.1002/qj.656
 
     Examples: