docstrings for UniformCDF

forecasttools/sbc_plots.py

@@ -137,12 +137,46 @@ def hist(ary, color, ax):
 
 
 class UniformCDF:
+    """
+    A class to represent the cumulative distribution function (CDF) of a
+    uniform distribution.
+    """
+
     def __init__(self, upper_bound):
+        """
+        Constructs all the necessary attributes for the UniformCDF object.
+
+        Parameters
+        ----------
+        upper_bound : float
+            The upper bound of the uniform distribution. Must be positive.
+
+        Raises
+        ------
+        ValueError
+            If upper_bound is not positive.
+        """
         if upper_bound <= 0:
-            raise ValueError(f"Upper bound must be positive; got {upper_bound}.")
+            raise ValueError(
+                f"Upper bound must be positive; got {upper_bound}."
+            )
         self.upper_bound = upper_bound
 
     def __call__(self, x):
+        """
+        Evaluates the CDF at a given value x.
+
+        Parameters
+        ----------
+        x : array-like
+            The value(s) at which to evaluate the CDF.
+
+        Returns
+        -------
+        array-like
+            The CDF evaluated at x. Returns 0 if x < 0, 1 if x > upper_bound,
+            and x / upper_bound otherwise.
+        """
         return np.where(
             x < 0, 0, np.where(x > self.upper_bound, 1, x / self.upper_bound)
         )