joel's remarks

jfalcou · Oct 9, 2023 · 045f30f · 045f30f
1 parent 5adf110
commit 045f30f
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/include/kyosu/functions/beta.hpp b/include/kyosu/functions/beta.hpp
@@ -61,7 +61,7 @@ namespace kyosu
 //!
 //!   **Parameters**
 //!
-//!     * `x`,`y` : Values to process. Can be a mix of cayley_dicson and real floating values.
+//!     * `x`,`y` : Values to process. Can be a mix of cayley_dickson and real floating values.
 //!
 //!   **Return value**
 //!

diff --git a/include/kyosu/functions/deta.hpp b/include/kyosu/functions/deta.hpp
@@ -56,7 +56,7 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!     constexpr auto deta(unsigned_scalar_value k, auto z) noexcept;
+//!     constexpr auto deta(unsigned_scalar_value auto k, auto z) noexcept;
 //!   }
 //!   @endcode
 //!

diff --git a/include/kyosu/functions/digamma.hpp b/include/kyosu/functions/digamma.hpp
@@ -52,7 +52,7 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!     constexpr auto  digamma(T z) noexcept;
+//!     constexpr auto  digamma(auto z) noexcept;
 //!   }
 //!   @endcode
 //!

diff --git a/include/kyosu/functions/erf.hpp b/include/kyosu/functions/erf.hpp
@@ -57,7 +57,8 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!      constexpr auto erf(auto z) noexcept;
+//!   {  template<eve::floating_ordered_value T>     constexpr T erf(T z) noexcept;
+//!      template<kyosu::concepts::cayley_dickson T> constexpr T erf(T z) noexcept;
 //!   }
 //!   @endcode
 //!
@@ -67,9 +68,7 @@ namespace kyosu
 //!
 //! **Return value**
 //!
-//!   * a real input z returns eve::erf(z),  a real typed value.
-//!
-//!   * The value of the error function is returned
+//!   * The value of the error function is returned.
 //!
 //!  @groupheader{Example}
 //!

diff --git a/include/kyosu/functions/is_imag.hpp b/include/kyosu/functions/is_imag.hpp
@@ -28,8 +28,8 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!      template<kyosu::concepts::cayley_dicson T> constexpr auto is_imag(T z) noexcept;
-//!      template<eve::floating_ordered_value T>    constexpr auto is_imag(T z) noexcept;
+//!      template<kyosu::concepts::cayley_dickson T> constexpr auto is_imag(T z) noexcept;
+//!      template<eve::floating_ordered_value T>     constexpr auto is_imag(T z) noexcept;
 //!   }
 //!   @endcode
 //!

diff --git a/include/kyosu/functions/zeta.hpp b/include/kyosu/functions/zeta.hpp
@@ -56,17 +56,18 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!      constexpr auto zeta(auto z) noexcept;
+//!      template<eve::floating_ordered_value T> constexpr auto zeta(T z) noexcept;
+//!      template<kyosu::concepts::complex T>    constexpr auto zeta(T z) noexcept;
 //!   }
 //!   @endcode
 //!
 //!   **Parameters**
 //!
-//!     * `z` : complex or real value to process.
+//!     * `z` : value to process.
 //!
 //! **Return value**
 //!
-//!   Returns the Dirichlet zeta function: \f$  \displaystyle \sum_0^\infty \frac{1}{(n+1)^z}\f$
+//!   Returns the Dirichlet zeta sum: \f$  \displaystyle \sum_0^\infty \frac{1}{(n+1)^z}\f$
 //!
 //!  @groupheader{Example}
 //!