Improve docstrings

pySTEPS · Mar 25, 2019 · 70dcd09 · 70dcd09
1 parent ed0e8b3
commit 70dcd09
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 12 deletions.
diff --git a/pysteps/verification/detcatscores.py b/pysteps/verification/detcatscores.py
@@ -81,7 +81,7 @@ def det_cat_fct(pred, obs, thr, scores="", axis=None):
 
     See also
     --------
-    pysteps.verification.detcontscores
+    pysteps.verification.detcontscores.det_cont_fct
 
 
     """

diff --git a/pysteps/verification/detcontscores.py b/pysteps/verification/detcontscores.py
@@ -63,11 +63,9 @@ def det_cont_fct(pred, obs, scores="", axis=None, conditioning=None):
         |  scatter*  | half the distance between the 16% and 84% percentiles  |
         |            | of the weighted cumulative error distribution,         |
         |            | where error = dB(pred/obs),                            |
-        |            | as in `Germann et al. (2006)`_                         |
+        |            | as in Germann et al. (2006)                            |
         +------------+--------------------------------------------------------+
 
-    .. _`Germann et al. (2006)`:https://doi.org/10.1256/qj.05.190
-
     axis : {int, tuple of int, None}, optional
         Axis or axes along which a score is integrated. The default, axis=None,
         will integrate all of the elements of the input arrays.\n
@@ -90,14 +88,19 @@ def det_cont_fct(pred, obs, scores="", axis=None, conditioning=None):
 
     Note
     ----
-    Score names denoted by * can only be computed offline.
-
+    Score names denoted by * can only be computed offline.\n
     Multiplicative scores can be computed by passing log-tranformed values.
 
+    References
+    ----------
+
+    Germann, U. , Galli, G. , Boscacci, M. and Bolliger, M. (2006), Radar
+    precipitation measurement in a mountainous region. Q.J.R. Meteorol. Soc.,
+    132: 1669-1692. doi:10.1256/qj.05.190
 
     See also
     --------
-    pysteps.verification.detcatscores
+    pysteps.verification.detcatscores.det_cat_fct
 
     """
 

diff --git a/pysteps/verification/interface.py b/pysteps/verification/interface.py
@@ -70,7 +70,7 @@ def get_method(name, type="deterministic"):
         |  scatter*  | half the distance between the 16% and 84% percentiles  |
         |            | of the weighted cumulative error distribution,         |
         |            | where error = dB(pred/obs),                            |
-        |            | as in `Germann et al. (2006)`_                         |
+        |            | as in Germann et al. (2006)                            |
         +------------+--------------------------------------------------------+
         |  binary_mse| binary MSE                                             |
         +------------+--------------------------------------------------------+
@@ -105,11 +105,15 @@ def get_method(name, type="deterministic"):
         |  ROC       | ROC curve                                              |
         +------------+--------------------------------------------------------+
 
-    type : str
-        Type of the method. The available options are 'deterministic', 'ensemble'
-        and 'probabilistic'.
+    type : {'deterministic', 'ensemble', 'probabilistic'}, optional
+        Type of the verification method.
 
-    .. _`Germann et al. (2006)`:https://doi.org/10.1256/qj.05.190
+    References
+    ----------
+    
+    Germann, U. , Galli, G. , Boscacci, M. and Bolliger, M. (2006), Radar 
+    precipitation measurement in a mountainous region. Q.J.R. Meteorol. Soc., 
+    132: 1669-1692. doi:10.1256/qj.05.190
 
     """