add reference to docs page for new diagnostics parameter

309ec0b4 · Thibault Hallouin · 602b486d · 309ec0b4 · 309ec0b4
Commit 309ec0b4 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
@@ -126,6 +126,8 @@ namespace evalhyd
    ///    diagnostics: ``std::vector<std::string>``, optional
    ///       The sequence of evaluation diagnostics to be computed.
    ///
+    ///       .. seealso:: :doc:`../../functionalities/diagnostics`
+    ///
    /// :Returns:
    ///
    ///    ``std::vector<xt::xarray<double>>``

--- a/include/evalhyd/evalp.hpp
+++ b/include/evalhyd/evalp.hpp
@@ -131,6 +131,8 @@ namespace evalhyd
    ///    diagnostics: ``std::vector<std::string>``, optional
    ///       The sequence of evaluation diagnostics to be computed.
    ///
+    ///       .. seealso:: :doc:`../../functionalities/diagnostics`
+    ///
    /// :Returns:
    ///
    ///    ``std::vector<xt::xarray<double>>``