From f6ad3078321c0de6eaf16dc0f44c95f3653a778c Mon Sep 17 00:00:00 2001 From: John Wellbelove Date: Sat, 30 May 2026 08:00:44 +0100 Subject: [PATCH] Fixed 'Description' typo --- docs/IO/io_port.md | 2 +- docs/binary/binary.md | 2 +- docs/containers/_index.md | 2 +- docs/containers/sets/const-multiset.md | 40 +++++++++++++------------- docs/containers/sets/const-set.md | 40 +++++++++++++------------- docs/maths/checksums-hashes.md | 2 +- docs/maths/correlation.md | 4 +-- docs/maths/gamma.md | 2 +- 8 files changed, 47 insertions(+), 47 deletions(-) diff --git a/docs/IO/io_port.md b/docs/IO/io_port.md index 67d4d70e..6293832e 100644 --- a/docs/IO/io_port.md +++ b/docs/IO/io_port.md @@ -275,7 +275,7 @@ Get an iterator to this port. const_iterator iter() const const_iterator citer() const ``` -**Decsription** +**Description** Get a `const_iterator` to this port. --- diff --git a/docs/binary/binary.md b/docs/binary/binary.md index 03cf2feb..566e5fea 100644 --- a/docs/binary/binary.md +++ b/docs/binary/binary.md @@ -198,7 +198,7 @@ Converts an N bit binary number, where bit N-1 is the sign bit, and shift is the template ETL_CONSTEXPR14 T count_leading_zeros(T value) ``` -**Decsription** +**Description** Counts the number of leading zeros in a binary number ## count_trailing_zeros diff --git a/docs/containers/_index.md b/docs/containers/_index.md index e5542b44..062edb53 100644 --- a/docs/containers/_index.md +++ b/docs/containers/_index.md @@ -4,7 +4,7 @@ weight: 100 --- ## Containers -The library defines a set of containers that have been specially tailored for embedded systems.They have a maximum capacity fixed at compile time and make no calls to `malloc`/`free` or `new`/`delete`. They are completely deterministic. +The library defines a set of containers that have been specially tailored for embedded systems. They have a maximum capacity fixed at compile time and make no calls to `malloc`/`free` or `new`/`delete`. They are completely deterministic. Most container types have been designed to mimic, as far as possible, those found in the STL. Some do not have direct STL equivalents. diff --git a/docs/containers/sets/const-multiset.md b/docs/containers/sets/const-multiset.md index 546f62c0..8d8fc79a 100644 --- a/docs/containers/sets/const-multiset.md +++ b/docs/containers/sets/const-multiset.md @@ -83,7 +83,7 @@ const_iterator Constant random access iterator template ETL_CONSTEXPR14 explicit const_multiset(TElements&&... elements) ETL_NOEXCEPT ``` -**Decsription** +**Description** Construct a `const_multiset` from a variadic list of elements. Static asserts if the elements are not of type `value_type`. Static asserts if the number of elements is greater than the capacity of the `const_multiset`. @@ -93,7 +93,7 @@ Static asserts if the number of elements is greater than the capacity of the `co ```cpp ETL_CONSTEXPR14 const_multiset_ext() ETL_NOEXCEPT ``` -**Decsription** +**Description** Default construct a `const_multiset`. --- @@ -102,7 +102,7 @@ Default construct a `const_multiset`. template ETL_CONSTEXPR14 explicit const_multiset_ext(const etl::span& sp) ETL_NOEXCEPT ``` -**Decsription** +**Description** Construct a `const_multiset` from a variadic list of elements. --- @@ -111,7 +111,7 @@ Construct a `const_multiset` from a variadic list of elements. template ETL_CONSTEXPR14 explicit const_multiset_ext(const value_type (&begin_)[Size]) ETL_NOEXCEPT ``` -**Decsription** +**Description** Construct a `const_multiset` from an array. ## Iterators @@ -120,7 +120,7 @@ Construct a `const_multiset` from an array. const_iterator begin() const ETL_NOEXCEPT const_iterator cbegin() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns an iterator to the beginning of the set. --- @@ -129,7 +129,7 @@ Returns an iterator to the beginning of the set. const_iterator end() const ETL_NOEXCEPT const_iterator cend() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns an iterator to the end of the set. ## Capacity @@ -137,7 +137,7 @@ Returns an iterator to the end of the set. ```cpp ETL_CONSTEXPR14 bool empty() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns `true` if the size of the set is zero, otherwise `false`. --- @@ -145,7 +145,7 @@ Returns `true` if the size of the set is zero, otherwise `false`. ```cpp ETL_CONSTEXPR14 bool full() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns `true` if the size of the lookup is size, otherwise `false`. --- @@ -153,7 +153,7 @@ Returns `true` if the size of the lookup is size, otherwise `false`. ```cpp ETL_CONSTEXPR14 size_t size() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns the size of the lookup. --- @@ -161,7 +161,7 @@ Returns the size of the lookup. ```cpp ETL_CONSTEXPR14 size_t max_size() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns the maximum possible size of the set. ## Status @@ -177,7 +177,7 @@ The elements must be sorted and contain no duplicates. ```cpp ETL_CONSTEXPR14 const_iterator find(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Find the `key` in the container. **Return** @@ -188,7 +188,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. ```cpp ETL_CONSTEXPR14 const_iterator lower_bound(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element after the `key`. **Return** @@ -199,7 +199,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. ```cpp ETL_CONSTEXPR14 const_iterator upper_bound(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element with the `key`. **Return** @@ -210,7 +210,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. ```cpp ETL_CONSTEXPR14 pair equal_range(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`) **Return** @@ -221,7 +221,7 @@ Returns a range containing all elements equivalent to `key`. ```cpp ETL_CONSTEXPR14 bool contains(const key_type& k) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Check if the container contains the key. **Return** @@ -233,7 +233,7 @@ Check if the container contains the key. template ETL_CONSTEXPR14 const_iterator find(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Find the `key` in the container. **Return** @@ -245,7 +245,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. template ETL_CONSTEXPR14 const_iterator lower_bound(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element after the `key`. **Return** @@ -257,7 +257,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. template ETL_CONSTEXPR14 const_iterator upper_bound(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element with the `key`. **Return** @@ -269,7 +269,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. template ETL_CONSTEXPR14 pair equal_range(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`) **Return** @@ -281,7 +281,7 @@ Returns a range containing all elements equivalent to `key`. template ETL_CONSTEXPR14 bool contains(const K& k) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Check if the container contains the key. **Return** diff --git a/docs/containers/sets/const-set.md b/docs/containers/sets/const-set.md index 0bca91c1..706eef0e 100644 --- a/docs/containers/sets/const-set.md +++ b/docs/containers/sets/const-set.md @@ -83,7 +83,7 @@ const_iterator Constant random access iterator template ETL_CONSTEXPR14 explicit const_set(TElements&&... elements) ETL_NOEXCEPT ``` -**Decsription** +**Description** Construct a `const_set` from a variadic list of elements. Static asserts if the elements are not of type `value_type`. Static asserts if the number of elements is greater than the capacity of the `const_set`. @@ -93,7 +93,7 @@ Static asserts if the number of elements is greater than the capacity of the `co ```cpp ETL_CONSTEXPR14 const_set_ext() ETL_NOEXCEPT ``` -**Decsription** +**Description** Default construct a `const_set`. --- @@ -102,7 +102,7 @@ Default construct a `const_set`. template ETL_CONSTEXPR14 explicit const_set_ext(const etl::span& sp) ETL_NOEXCEPT ``` -**Decsription** +**Description** Construct a `const_set` from a variadic list of elements. --- @@ -111,7 +111,7 @@ Construct a `const_set` from a variadic list of elements. template ETL_CONSTEXPR14 explicit const_set_ext(const value_type (&begin_)[Size]) ETL_NOEXCEPT ``` -**Decsription** +**Description** Construct a `const_set` from an array. ## Iterators @@ -120,7 +120,7 @@ Construct a `const_set` from an array. const_iterator begin() const ETL_NOEXCEPT const_iterator cbegin() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns an iterator to the beginning of the set. --- @@ -129,7 +129,7 @@ Returns an iterator to the beginning of the set. const_iterator end() const ETL_NOEXCEPT const_iterator cend() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns an iterator to the end of the set. ## Capacity @@ -137,7 +137,7 @@ Returns an iterator to the end of the set. ```cpp ETL_CONSTEXPR14 bool empty() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns `true` if the size of the set is zero, otherwise `false`. --- @@ -145,7 +145,7 @@ Returns `true` if the size of the set is zero, otherwise `false`. ```cpp ETL_CONSTEXPR14 bool full() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns `true` if the size of the lookup is size, otherwise `false`. --- @@ -153,7 +153,7 @@ Returns `true` if the size of the lookup is size, otherwise `false`. ```cpp ETL_CONSTEXPR14 size_t size() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns the size of the lookup. --- @@ -161,7 +161,7 @@ Returns the size of the lookup. ```cpp ETL_CONSTEXPR14 size_t max_size() const ETL_NOEXCEPT ``` -**Decsription** +**Description** Returns the maximum possible size of the set. ## Status @@ -177,7 +177,7 @@ The elements must be sorted and contain no duplicates. ```cpp ETL_CONSTEXPR14 const_iterator find(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Find the `key` in the container. **Return** @@ -188,7 +188,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. ```cpp ETL_CONSTEXPR14 const_iterator lower_bound(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element after the `key`. **Return** @@ -199,7 +199,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. ```cpp ETL_CONSTEXPR14 const_iterator upper_bound(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element with the `key`. **Return** @@ -210,7 +210,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. ```cpp ETL_CONSTEXPR14 pair equal_range(const key_type& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`) **Return** @@ -221,7 +221,7 @@ Returns a range containing all elements equivalent to `key`. ```cpp ETL_CONSTEXPR14 bool contains(const key_type& k) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Check if the container contains the key. **Return** @@ -233,7 +233,7 @@ Check if the container contains the key. template ETL_CONSTEXPR14 const_iterator find(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Find the `key` in the container. **Return** @@ -245,7 +245,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. template ETL_CONSTEXPR14 const_iterator lower_bound(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element after the `key`. **Return** @@ -257,7 +257,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. template ETL_CONSTEXPR14 const_iterator upper_bound(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Searches for the first element with the `key`. **Return** @@ -269,7 +269,7 @@ A `const_iterator` to the element, or `end()` if it could not be found. template ETL_CONSTEXPR14 pair equal_range(const K& key) const ETL_NOEXCEPT ``` -**Decsription** +**Description** The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`) **Return** @@ -281,7 +281,7 @@ Returns a range containing all elements equivalent to `key`. template ETL_CONSTEXPR14 bool contains(const K& k) const ETL_NOEXCEPT ``` -**Decsription** +**Description** Check if the container contains the key. **Return** diff --git a/docs/maths/checksums-hashes.md b/docs/maths/checksums-hashes.md index b0fecec2..d2f81dfb 100644 --- a/docs/maths/checksums-hashes.md +++ b/docs/maths/checksums-hashes.md @@ -359,7 +359,7 @@ Creates a hash from the supplied range. ```cpp void reset(); ``` -**Decsription** +**Description** Resets the hash to the initial condition. --- diff --git a/docs/maths/correlation.md b/docs/maths/correlation.md index 7dfdae2f..ada96f55 100644 --- a/docs/maths/correlation.md +++ b/docs/maths/correlation.md @@ -34,7 +34,7 @@ Default constructor. template correlation(TIterator first1, TIterator last1, TIterator first2) ``` -**Decsription** +**Description** Construct from two iterator ranges. ```cpp @@ -71,7 +71,7 @@ Add a range of values. ```cpp double get_covariance() const ``` -**Decsription** +**Description** Returns the calculated covariance for the data. --- diff --git a/docs/maths/gamma.md b/docs/maths/gamma.md index df76ca31..59603127 100644 --- a/docs/maths/gamma.md +++ b/docs/maths/gamma.md @@ -39,7 +39,7 @@ Gamma a value. ```cpp gamma_decode(double gamma, TInput maximum) ``` -**Decsription** +**Description** Constructor. ---