correct documented output type for evalp

bc80be73 · Thibault Hallouin · a2957cb3 · bc80be73
Commit bc80be73 authored 2 years ago by Thibault Hallouin
Hide whitespace changes
Inline Side-by-side

Showing

with 5 additions and 3 deletions
+5 -3
--- a/include/evalhyd/evalp.hpp
+++ b/include/evalhyd/evalp.hpp
@@ -47,9 +47,11 @@ namespace evalhyd
    ///
    /// :Returns:
    ///
-    ///    ``std::vector<xt::xtensor<double, 5>>``
+    ///    ``std::vector<xt::xarray<double>>``
-    ///       The sequence of evaluation metrics computed
+    ///       The sequence of evaluation metrics computed in the same order
-    ///       in the same order as given in *metrics*.
+    ///       as given in *metrics*.
+    ///       shape: (metrics,)<(sites, lead times, subsets, {quantiles,}
+    ///       {thresholds,} {components})>
    ///
    /// :Examples:
    ///