Better docstrings

dpa_check/dpa_check.py

@@ -36,13 +36,24 @@ def __init__(self):
                                        hist_limit)
 
     def custom_prediction_plots(self, plots):
+        """
+        Customization of prediction plots.
+
+        Parameters
+        ----------
+        plots : dict of dicts
+            Contains the hooks to the plot figures, axes, and filenames
+            and can be used to customize plots before they are written,
+            e.g. add limit lines, etc.
+        """
         plots[self.name]['ax'].axhline(self.zero_feps_limit, linestyle='--',
                                        color='dodgerblue', label="Zero FEPs",
                                        linewidth=2.0)
 
     def custom_prediction_viols(self, times, temp, viols, load_start):
         """
-        Custom handling of limit violations. 
+        Custom handling of limit violations. This is for checking the
+        +12 degC violation if all FEPs are off. 
 
         Parameters
         ----------
@@ -68,6 +79,16 @@ def custom_prediction_viols(self, times, temp, viols, load_start):
                               "values": zf_viols}
 
     def custom_validation_plots(self, plots):
+        """
+        Customization of validation plots.
+
+        Parameters
+        ----------
+        plots : dict of dicts
+            Contains the hooks to the plot figures, axes, and filenames
+            and can be used to customize plots before they are written,
+            e.g. add limit lines, etc.
+        """
         plots[0]['lines']['ax'].axhline(self.zero_feps_limit, linestyle='--',
                                         color='dodgerblue', zorder=-8,
                                         linewidth=2, label="Zero FEPs")