Commit 64029288 authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

document missing template parameter XS2

1 merge request!3release v0.1.0
Pipeline #43957 failed with stage
in 3 minutes and 23 seconds
Showing with 12 additions and 2 deletions
+12 -2
...@@ -36,6 +36,11 @@ namespace evalhyd ...@@ -36,6 +36,11 @@ namespace evalhyd
/// (e.g. ``xt::xtensor<bool, 3>``, ``xt::pytensor<bool, 3>``, /// (e.g. ``xt::xtensor<bool, 3>``, ``xt::pytensor<bool, 3>``,
/// ``xt::rtensor<bool, 3>``, etc.). /// ``xt::rtensor<bool, 3>``, etc.).
/// ///
/// XS2: Any 2-dimensional container class storing string elements
/// (e.g. ``xt::xtensor<std::array<char, 32>, 2>``,
/// ``xt::pytensor<std::array<char, 32>, 2>``,
/// ``xt::rtensor<std::array<char, 32>, 2>``, etc.).
///
/// :Parameters: /// :Parameters:
/// ///
/// q_obs: ``XD2`` /// q_obs: ``XD2``
...@@ -84,7 +89,7 @@ namespace evalhyd ...@@ -84,7 +89,7 @@ namespace evalhyd
/// ///
/// .. seealso:: :doc:`../../functionalities/temporal-masking` /// .. seealso:: :doc:`../../functionalities/temporal-masking`
/// ///
/// m_cdt: ``xt::xtensor<std::array<char, 32>, 2>``, optional /// m_cdt: ``XS2``, optional
/// Masking conditions to use to generate temporal subsets. Each /// Masking conditions to use to generate temporal subsets. Each
/// condition consists in a string and can be specified on observed /// condition consists in a string and can be specified on observed
/// streamflow values/statistics (mean, median, quantile), or on time /// streamflow values/statistics (mean, median, quantile), or on time
......
...@@ -41,6 +41,11 @@ namespace evalhyd ...@@ -41,6 +41,11 @@ namespace evalhyd
/// (e.g. ``xt::xtensor<bool, 4>``, ``xt::pytensor<bool, 4>``, /// (e.g. ``xt::xtensor<bool, 4>``, ``xt::pytensor<bool, 4>``,
/// ``xt::rtensor<bool, 4>``, etc.). /// ``xt::rtensor<bool, 4>``, etc.).
/// ///
/// XS2: Any 2-dimensional container class storing string elements
/// (e.g. ``xt::xtensor<std::array<char, 32>, 2>``,
/// ``xt::pytensor<std::array<char, 32>, 2>``,
/// ``xt::rtensor<std::array<char, 32>, 2>``, etc.).
///
/// :Parameters: /// :Parameters:
/// ///
/// q_obs: ``XD2`` /// q_obs: ``XD2``
...@@ -88,7 +93,7 @@ namespace evalhyd ...@@ -88,7 +93,7 @@ namespace evalhyd
/// ///
/// .. seealso:: :doc:`../../functionalities/temporal-masking` /// .. seealso:: :doc:`../../functionalities/temporal-masking`
/// ///
/// m_cdt: ``xt::xtensor<std::array<char, 32>, 2>``, optional /// m_cdt: ``XS2``, optional
/// Masking conditions to use to generate temporal subsets. Each /// Masking conditions to use to generate temporal subsets. Each
/// condition consists in a string and can be specified on /// condition consists in a string and can be specified on
/// observed/predicted streamflow values/statistics (mean, median, /// observed/predicted streamflow values/statistics (mean, median,
......
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