Auto-generated commit

stdlib-bot · stdlib-bot · commit 0dc76abc4433 · 2024-09-21T21:28:26.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-17)
+## Unreleased (2024-09-21)
 
 <section class="packages">
 
@@ -32,6 +32,7 @@ A total of 1 person contributed to this release. Thank you to this contributor:
 
 <details>
 
+-   [`6e9f42e`](https://github.com/stdlib-js/stdlib/commit/6e9f42e4c912485d9896eaa16c88b70fd3688e97) - **docs:** harmonize list formatting in repl.txt and ensure starting newline _(by Philipp Burckhardt)_
 -   [`ed44fee`](https://github.com/stdlib-js/stdlib/commit/ed44feecb9eaa5e0849d1a533e5415624d0aa338) - **style:** use imperative in package.json description and end with period _(by Philipp Burckhardt)_
 -   [`cadb613`](https://github.com/stdlib-js/stdlib/commit/cadb6131d6ce50338d11757e88e8a910a0367983) - **chore:** update argument documentation styling _(by Philipp Burckhardt)_
 
diff --git a/any-by/docs/repl.txt b/any-by/docs/repl.txt
@@ -5,8 +5,8 @@
 
     The predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index
+    - value: iterated value.
+    - index: iteration index.
 
     The function immediately returns upon encountering a truthy return value.
 
diff --git a/cunone-by/docs/repl.txt b/cunone-by/docs/repl.txt
@@ -8,8 +8,8 @@
 
     The predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index
+    - value: iterated value.
+    - index: iteration index.
 
     A predicate function is invoked for each iterated value until the first
     truthy predicate function return value. Upon encountering the first truthy
diff --git a/dedupe-by/docs/repl.txt b/dedupe-by/docs/repl.txt
@@ -5,11 +5,11 @@
 
     The provided function is provided five arguments:
 
-    - curr: current source iterated value
-    - sprev: previous source iterated value
-    - dprev: previous downstream iterated value
-    - index: source iteration index (zero-based)
-    - acc: previous resolved value
+    - curr: current source iterated value.
+    - sprev: previous source iterated value.
+    - dprev: previous downstream iterated value.
+    - index: source iteration index (zero-based).
+    - acc: previous resolved value.
 
     If an environment supports Symbol.iterator and a provided iterator is
     iterable, the returned iterator is iterable.
diff --git a/do-until-each/docs/repl.txt b/do-until-each/docs/repl.txt
@@ -1,6 +1,6 @@
 
 {{alias}}( iterator, predicate, fcn[, thisArg] )
-    Returns an iterator which invokes a function for each iterated value before 
+    Returns an iterator which invokes a function for each iterated value before
     returning the iterated value until either a predicate function returns true
     or the iterator has iterated over all values.
 
@@ -9,8 +9,8 @@
 
     When invoked, both input functions are provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator, the returned iterator is
     iterable.
diff --git a/do-while-each/docs/repl.txt b/do-while-each/docs/repl.txt
@@ -1,6 +1,6 @@
 
 {{alias}}( iterator, predicate, fcn[, thisArg] )
-    Returns an iterator which invokes a function for each iterated value before 
+    Returns an iterator which invokes a function for each iterated value before
     returning the iterated value until either a predicate function returns false
     or the iterator has iterated over all values.
 
@@ -9,8 +9,8 @@
 
     When invoked, both input functions are provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator, the returned iterator is
     iterable.
diff --git a/every-by/docs/repl.txt b/every-by/docs/repl.txt
@@ -5,8 +5,8 @@
 
     The predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index
+    - value: iterated value.
+    - index: iteration index.
 
     The function immediately returns upon encountering a falsy return value.
 
diff --git a/filter-map/docs/repl.txt b/filter-map/docs/repl.txt
@@ -5,8 +5,8 @@
 
     When invoked, the callback function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If the callback returns `undefined`, the iterator invokes the function for
     the next value of the provided iterator; otherwise, the iterator returns
diff --git a/filter/docs/repl.txt b/filter/docs/repl.txt
@@ -5,8 +5,8 @@
 
     When invoked, the predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator and a provided iterator is
     iterable, the returned iterator is iterable.
diff --git a/for-each/docs/repl.txt b/for-each/docs/repl.txt
@@ -5,8 +5,8 @@
 
     When invoked, the input function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator, the returned iterator is
     iterable.
diff --git a/map/docs/repl.txt b/map/docs/repl.txt
@@ -4,8 +4,8 @@
 
     When invoked, the input function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator and a provided iterator is
     iterable, the returned iterator is iterable.
diff --git a/mapn/docs/repl.txt b/mapn/docs/repl.txt
@@ -8,8 +8,8 @@
     is the number of provided iterators and the last argument is the iteration
     index:
 
-    -  ...value: iterated values
-    -  index: iteration index (zero-based)
+    - ...value: iterated values.
+    - index: iteration index (zero-based).
 
     The length of the returned iterator is equal to the length of the shortest
     provided iterator. In other words, the returned iterator ends once *one* of
diff --git a/none-by/docs/repl.txt b/none-by/docs/repl.txt
@@ -5,8 +5,8 @@
 
     The predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index
+    - value: iterated value.
+    - index: iteration index.
 
     The function immediately returns upon encountering a truthy return value.
 
diff --git a/reject/docs/repl.txt b/reject/docs/repl.txt
@@ -5,8 +5,8 @@
 
     When invoked, the predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator and a provided iterator is
     iterable, the returned iterator is iterable.
diff --git a/replicate-by/docs/repl.txt b/replicate-by/docs/repl.txt
@@ -5,9 +5,9 @@
 
     The callback function is provided three arguments:
 
-    - value: iterated value
-    - index: source iteration index (zero-based)
-    - n: iteration index (zero-based)
+    - value: iterated value.
+    - index: source iteration index (zero-based).
+    - n: iteration index (zero-based).
 
     The callback function is invoked *once* per iterated value of the provided
     iterator.
diff --git a/some-by/docs/repl.txt b/some-by/docs/repl.txt
@@ -5,8 +5,8 @@
 
     The predicate function is provided two arguments:
 
-    - value: iterated value
-    - index: iteration index
+    - value: iterated value.
+    - index: iteration index.
 
     The function immediately returns upon encountering `n` truthy return values.
 
diff --git a/strided-by/docs/repl.txt b/strided-by/docs/repl.txt
@@ -4,10 +4,10 @@
 
     When invoked, the input function is provided four arguments:
 
-    - value: iterated value
-    - i: input iteration index (zero-based)
-    - n: output (strided) iteration index (zero-based)
-    - curr: current stride
+    - value: iterated value.
+    - i: input iteration index (zero-based).
+    - n: output (strided) iteration index (zero-based).
+    - curr: current stride.
 
     The return value of the input function specifies the next stride.
 
diff --git a/to-array-view-right/docs/repl.txt b/to-array-view-right/docs/repl.txt
@@ -5,9 +5,9 @@
 
     When invoked, an input function is provided three arguments:
 
-    - value: iterated value
-    - index: destination index (zero-based)
-    - n: iteration index (zero-based)
+    - value: iterated value.
+    - index: destination index (zero-based).
+    - n: iteration index (zero-based).
 
     Iteration stops when an output array view is full or an iterator finishes;
     whichever comes first.
diff --git a/to-array-view/docs/repl.txt b/to-array-view/docs/repl.txt
@@ -4,9 +4,9 @@
 
     When invoked, an input function is provided three arguments:
 
-    - value: iterated value
-    - index: destination index (zero-based)
-    - n: iteration index (zero-based)
+    - value: iterated value.
+    - index: destination index (zero-based).
+    - n: iteration index (zero-based).
 
     Iteration stops when an output array view is full or an iterator finishes;
     whichever comes first.
diff --git a/until-each/docs/repl.txt b/until-each/docs/repl.txt
@@ -1,13 +1,13 @@
 
 {{alias}}( iterator, predicate, fcn[, thisArg] )
-    Returns an iterator which invokes a function for each iterated value before 
+    Returns an iterator which invokes a function for each iterated value before
     returning the iterated value until either a predicate function returns true
     or the iterator has iterated over all values.
 
     When invoked, both input functions are provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator, the returned iterator is
     iterable.
diff --git a/while-each/docs/repl.txt b/while-each/docs/repl.txt
@@ -1,13 +1,13 @@
 
 {{alias}}( iterator, predicate, fcn[, thisArg] )
-    Returns an iterator which invokes a function for each iterated value before 
+    Returns an iterator which invokes a function for each iterated value before
     returning the iterated value until either a predicate function returns false
     or the iterator has iterated over all values.
 
     When invoked, both input functions are provided two arguments:
 
-    - value: iterated value
-    - index: iteration index (zero-based)
+    - value: iterated value.
+    - index: iteration index (zero-based).
 
     If an environment supports Symbol.iterator, the returned iterator is
     iterable.
