From 75793d3ddeb0c6efaa20464f4c2dc979e23a4611 Mon Sep 17 00:00:00 2001
From: Thibault Hallouin <thibault.hallouin@inrae.fr>
Date: Sat, 21 Jan 2023 12:13:12 +0100
Subject: [PATCH] add missing parameters to docstrings
---
include/evalhyd/detail/probabilist/brier.hpp | 6 +++++-
include/evalhyd/detail/probabilist/contingency.hpp | 3 +++
include/evalhyd/detail/probabilist/quantiles.hpp | 4 ++++
3 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/include/evalhyd/detail/probabilist/brier.hpp b/include/evalhyd/detail/probabilist/brier.hpp
index 945fe75..626b71a 100644
--- a/include/evalhyd/detail/probabilist/brier.hpp
+++ b/include/evalhyd/detail/probabilist/brier.hpp
@@ -31,6 +31,8 @@ namespace evalhyd
/// \param q_thr
/// Streamflow exceedance threshold(s).
/// shape: (sites, thresholds)
+ /// \param is_high_flow_event
+ /// Whether events correspond to being above the threshold(s).
/// \return
/// Event observed outcome.
/// shape: (sites, thresholds, time)
@@ -130,6 +132,8 @@ namespace evalhyd
/// \param q_thr
/// Streamflow exceedance threshold(s).
/// shape: (sites, thresholds)
+ /// \param is_high_flow_event
+ /// Whether events correspond to being above the threshold(s).
/// \return
/// Number of forecast members exceeding threshold(s).
/// shape: (sites, lead times, thresholds, time)
@@ -406,7 +410,7 @@ namespace evalhyd
xt::all(), e, xt::all());
// calculate length of subset
- auto l = xt::sum(t_msk_sampled, -1); // (sit, ldt, 1)
+ auto l = xt::sum(t_msk_sampled, -1);
// compute mask to subsample time steps belonging to same forecast bin
// (where bins are defined as the range of forecast values)
diff --git a/include/evalhyd/detail/probabilist/contingency.hpp b/include/evalhyd/detail/probabilist/contingency.hpp
index 533e4ba..0c3aa0e 100644
--- a/include/evalhyd/detail/probabilist/contingency.hpp
+++ b/include/evalhyd/detail/probabilist/contingency.hpp
@@ -503,6 +503,9 @@ namespace evalhyd
/// \param POFD
/// Probabilities of false detection.
/// shape: (sites, lead times, subsets, samples, levels, thresholds)
+ /// \param q_thr
+ /// Streamflow exceedance threshold(s).
+ /// shape: (sites, thresholds)
/// \return
/// ROC skill scores.
/// shape: (sites, lead times, subsets, samples, thresholds)
diff --git a/include/evalhyd/detail/probabilist/quantiles.hpp b/include/evalhyd/detail/probabilist/quantiles.hpp
index 471f8b3..5a2fe60 100644
--- a/include/evalhyd/detail/probabilist/quantiles.hpp
+++ b/include/evalhyd/detail/probabilist/quantiles.hpp
@@ -50,6 +50,8 @@ namespace evalhyd
/// \param q_qnt
/// Streamflow quantiles.
/// shape: (sites, lead times, quantiles, time)
+ /// \param n_mbr
+ /// Number of ensemble members.
/// \return
/// Quantile scores for each time step.
/// shape: (sites, lead times, quantiles, time)
@@ -93,6 +95,8 @@ namespace evalhyd
/// \param qs
/// Quantile scores for each time step.
/// shape: (sites, lead times, quantiles, time)
+ /// \param n_mbr
+ /// Number of ensemble members.
/// \return
/// CRPS for each time step.
/// shape: (sites, lead times, time)
--
GitLab