From 0ee81fd8ee076d0d797b48acaf5daa3ece053c12 Mon Sep 17 00:00:00 2001
From: Thibault Hallouin <thibault.hallouin@inrae.fr>
Date: Wed, 26 Oct 2022 19:20:30 +0200
Subject: [PATCH] rely on centralised doc for flow transformation
---
include/evalhyd/evald.hpp | 18 ++----------------
1 file changed, 2 insertions(+), 16 deletions(-)
diff --git a/include/evalhyd/evald.hpp b/include/evalhyd/evald.hpp
index 354a32a..7ae018e 100644
--- a/include/evalhyd/evald.hpp
+++ b/include/evalhyd/evald.hpp
@@ -44,23 +44,9 @@ namespace evalhyd
///
/// transform: ``std::string``, optional
/// The transformation to apply to both streamflow observations and
- /// predictions prior to the calculation of the *metrics*. The options
- /// are listed in the table below.
+ /// predictions prior to the calculation of the *metrics*.
///
- /// ========================= ==================================
- /// transformations details
- /// ========================= ==================================
- /// ``"sqrt"`` The square root function
- /// **f(Q) = √Q** is applied.
- /// ``"pow"`` The power function
- /// **f(Q) = Qâ¿** is applied (where
- /// the power **n** can be set through
- /// the *exponent* parameter).
- /// ``"inv"`` The reciprocal function
- /// **f(Q) = 1/Q** is applied.
- /// ``"log"`` The natural logarithm function
- /// **f(Q) = ln(Q)** is applied.
- /// ========================= ==================================
+ /// .. seealso:: :doc:`../../functionalities/transformation`
///
/// exponent: ``double``, optional
/// The value of the exponent n to use when the *transform* is the
--
GitLab