From 4bedaa4786242a771c863a472aeca500d97c18e2 Mon Sep 17 00:00:00 2001 From: John Wellbelove Date: Sun, 18 Oct 2026 10:17:04 +0100 Subject: [PATCH] Various documantation fixes --- docs/maths/math.md | 4 ++-- docs/types/type-list.md | 4 ++-- docs/utilities/compare.md | 32 +++++++++++++++++++++++++------- docs/utilities/cyclic-value.md | 6 ++++-- 4 files changed, 33 insertions(+), 13 deletions(-) diff --git a/docs/maths/math.md b/docs/maths/math.md index 3ec1cc88..71e6cc6d 100644 --- a/docs/maths/math.md +++ b/docs/maths/math.md @@ -38,7 +38,7 @@ ETL_CONSTEXPR bool is_zero(T value) **Returns** `true` if `value` is Zero. -## is_exactly_zero +## is_exactly_equal ```cpp template @@ -260,7 +260,7 @@ A wrapper around `::powl` in ``. If `ETL_NO_LONG_DOUBLE_MATH` is defined then returns `::pow` with casts to `double`. otherwise -`::powl(base, intpart)` +`::powl(base, exponent)` ## modf diff --git a/docs/types/type-list.md b/docs/types/type-list.md index 04062874..1aa70f20 100644 --- a/docs/types/type-list.md +++ b/docs/types/type-list.md @@ -126,7 +126,6 @@ struct type_list_contains ``` **Description** Defines `value` as `true` if the `type_list` contains the specified type, otherwise `false`. -From: `C++17` --- @@ -135,7 +134,8 @@ template constexpr bool type_list_contains_v ``` **Description** -Defined as `true` if the `type_list` contains the specified type, otherwise `false`. +Defined as `true` if the `type_list` contains the specified type, otherwise `false`. +From: `C++17` ## type_list_has_duplicates_of ```cpp diff --git a/docs/utilities/compare.md b/docs/utilities/compare.md index 54d904e5..e4b647b7 100644 --- a/docs/utilities/compare.md +++ b/docs/utilities/compare.md @@ -28,54 +28,72 @@ second_argument_type; cmp_result; ``` -`cmp_result` has the values `Less`, `Equal`, and `Greater`. +`cmp_result` defines the values `Less`, `Equal`, and `Greater`. ## Members ```cpp static bool lt(first_argument_type lhs, second_argument_type rhs) ``` +**Description** +Less than. + **Return** -`true` if `lhs < rhs`, otherwise `false`. +`true` if `TLess()(lhs, rhs)`, otherwise `false`. --- ```cpp static bool lte(first_argument_type lhs, second_argument_type rhs) ``` +**Description** +Less than or equal. + **Return** -`true` if `lhs <= rhs`, otherwise `false`. +`true` if `lhs` is less than or equal to `rhs`, otherwise `false`. --- ```cpp static bool gt(first_argument_type lhs, second_argument_type rhs) ``` +**Description** +Greater than. + **Return** -`true` if `lhs > rhs`, otherwise `false`. +`true` if `lhs` is greater than `rhs`, otherwise `false`. --- ```cpp static bool gte(first_argument_type lhs, second_argument_type rhs) ``` +**Description** +Greater than or equal. + **Return** -`true` if `lhs >= rhs`, otherwise `false`. +`true` if `lhs` is greater than or equal to `rhs`, otherwise `false`. --- ```cpp static bool eq(first_argument_type lhs, second_argument_type rhs) ``` +**Description** +Equal. + **Return** -`true` if `lhs == rhs`, otherwise `false`. +`true` if neither value compares less than the other, otherwise `false`. --- ```cpp static bool ne(first_argument_type lhs, second_argument_type rhs) ``` +**Description** +Not equal. + **Return** -`true` if `lhs != rhs`, otherwise `false`. +`true` if if either value compare less than the other, otherwise `false`. --- diff --git a/docs/utilities/cyclic-value.md b/docs/utilities/cyclic-value.md index d29a7b42..b2554bd9 100644 --- a/docs/utilities/cyclic-value.md +++ b/docs/utilities/cyclic-value.md @@ -221,10 +221,12 @@ Checks equality of two cyclic values. Previously the first and last limits were also considered. <= 20.49.0 - `etl::cyclic_value<2, 7>(3) != etl::cyclic_value<2, 6>(3)` + `etl::cyclic_value(3) != etl::cyclic_value(3)` + `etl::cyclic_value(2, 7, 3) != etl::cyclic_value(2, 6, 3)` > 20.49.0 - `etl::cyclic_value<2, 7>(3) == etl::cyclic_value<2, 6>(3)` + `etl::cyclic_value(3) == etl::cyclic_value(3)` + `etl::cyclic_value(2, 7, 3) == etl::cyclic_value(2, 6, 3)` {{< /callout >}} ---