add link to docs for list of metrics in docstrings

cbe1588d · Thibault Hallouin · 02f9b78b · cbe1588d · cbe1588d
Commit cbe1588d authored 2 years ago by Thibault Hallouin
Hide whitespace changes
Inline Side-by-side

Showing

with 4 additions and 0 deletions
+4 -0
--- a/include/evalhyd/evald.hpp
+++ b/include/evalhyd/evald.hpp
@@ -60,6 +60,8 @@ namespace evalhyd
    ///    metrics: ``std::vector<std::string>``
    ///       The sequence of evaluation metrics to be computed.
    ///
+    ///       .. seealso:: :doc:`../../metrics/deterministic`
+    ///
    ///    q_thr: ``XD2``, optional
    ///       Streamflow exceedance threshold(s). If provided, *events* must
    ///       also be provided.

--- a/include/evalhyd/evalp.hpp
+++ b/include/evalhyd/evalp.hpp
@@ -65,6 +65,8 @@ namespace evalhyd
    ///    metrics: ``std::vector<std::string>``
    ///       The sequence of evaluation metrics to be computed.
    ///
+    ///       .. seealso:: :doc:`../../metrics/probabilistic`
+    ///
    ///    q_thr: ``XD2``, optional
    ///       Streamflow exceedance threshold(s). If provided, *events* must
    ///       also be provided.