Merge pull request #507 from DHI/plot_attr

Add .plot attributes with links to docs

Author: ecomodeller

docs/_quarto.yml

@@ -188,6 +188,7 @@ quartodoc:
           members: []
         - name: Comparer
           members:
+            - plot
             - skill
             - gridded_skill
             - score
@@ -202,6 +203,7 @@ quartodoc:
 
         - name: ComparerCollection
           members:
+            - plot
             - skill
             - mean_skill
             - gridded_skill

modelskill/comparison/_collection.py

@@ -101,15 +101,7 @@ def __init__(self, comparers: Iterable[Comparer]) -> None:
                 self._comparers[cmp.name] = cmp
 
         self.plot = ComparerCollection.plotter(self)
-        """Plot using the ComparerCollectionPlotter
-
-        Examples
-        --------
-        >>> cc.plot.scatter()
-        >>> cc.plot.kde()
-        >>> cc.plot.taylor()
-        >>> cc.plot.hist()
-        """
+        """Plot using the [](`~modelskill.comparison.ComparerCollectionPlotter`)"""
 
     @property
     def _name(self) -> str:

modelskill/comparison/_comparison.py

@@ -490,19 +490,7 @@ def __init__(
                 ), f"raw_mod_data[{k}] must be a TimeSeries object"
 
         self.plot = Comparer.plotter(self)
-        """Plot using the ComparerPlotter
-
-        Examples
-        --------
-        >>> cmp.plot.timeseries()
-        >>> cmp.plot.scatter()
-        >>> cmp.plot.qq()
-        >>> cmp.plot.hist()
-        >>> cmp.plot.kde()
-        >>> cmp.plot.box()
-        >>> cmp.plot.residual_hist()
-        >>> cmp.plot.taylor()        
-        """
+        """Plot using the [](`~modelskill.comparison.ComparerPlotter`)"""
 
     @staticmethod
     def from_matched_data(