Commit 12ff42b6 authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

clarify docstrings on recently improved masking conditions

No related merge requests found
Pipeline #39162 passed with stages
in 3 minutes and 15 seconds
Showing with 12 additions and 12 deletions
+12 -12
......@@ -104,11 +104,11 @@ namespace evalhyd
/// m_cdt: ``xt::xtensor<std::array<char, 32>, N>``, optional
/// Masking conditions to use to generate temporal subsets. Each
/// condition consists in a string and can be specified on observed
/// streamflow values, or on time indices. If provided in combination
/// with *t_msk*, the latter takes precedence. If not provided and
/// neither is *t_msk*, no subset is performed. If provided, there
/// must be as many conditions as there are time series of
/// observations.
/// streamflow values/statistics (mean, median, quantile), or on time
/// indices. If provided in combination with *t_msk*, the latter takes
/// precedence. If not provided and neither is *t_msk*, no subset is
/// performed. If provided, there must be as many conditions as there
/// are time series of observations.
/// shape: ({... ,} 1)
///
/// .. seealso:: :doc:`../../functionalities/conditional-masking`
......
......@@ -58,13 +58,13 @@ namespace evalhyd
///
/// m_cdt: ``xt::xtensor<std::array<char, 32>, 2>``, optional
/// Masking conditions to use to generate temporal subsets. Each
/// condition consists in a string and can be specified on observed
/// or predicted streamflow values, or on time indices. If provided
/// in combination with *t_msk*, the latter takes precedence. If not
/// provided and neither is *t_msk*, no subset is performed and only
/// one set of metrics is returned corresponding to the whole time
/// series. If provided, as many sets of metrics are returned as they
/// are conditions provided.
/// condition consists in a string and can be specified on
/// observed/predicted streamflow values/statistics (mean, median,
/// quantile), or on time indices. If provided in combination with
/// *t_msk*, the latter takes precedence. If not provided and neither
/// is *t_msk*, no subset is performed and only one set of metrics is
/// returned corresponding to the whole time series. If provided, as
/// many sets of metrics are returned as they are conditions provided.
/// shape: (sites, subsets)
///
/// .. seealso:: :doc:`../../functionalities/conditional-masking`
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment