Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-11-10)
+## Unreleased (2025-11-13)
 
 <section class="features">
 
@@ -22,6 +22,8 @@
 
 <details>
 
+-   [`9ef2243`](https://github.com/stdlib-js/stdlib/commit/9ef2243e74763fa05f732c476492b18e9d3711c1) - **docs:** add notes _(by Athan Reines)_
+-   [`c84485f`](https://github.com/stdlib-js/stdlib/commit/c84485fea2e4dfabf2d07dcfa9dabe68a854f72f) - **docs:** update notes _(by Athan Reines)_
 -   [`b3817aa`](https://github.com/stdlib-js/stdlib/commit/b3817aa9b503e211474c485bc381251d47aa308b) - **docs:** fix function signature and remove extrs spaces _(by Philipp Burckhardt)_
 -   [`af7c8c4`](https://github.com/stdlib-js/stdlib/commit/af7c8c4e389209dd4004613c251d449e99ba09f7) - **style:** add missing spaces _(by Philipp Burckhardt)_
 -   [`c46348e`](https://github.com/stdlib-js/stdlib/commit/c46348e63572c385a5a10c111a0214c9bb28eeec) - **docs:** update copy _(by Athan Reines)_

README.md

@@ -148,7 +148,29 @@ dlinspace.ndarray( 3, 1.0, 3.0, true, x, 1, x.length-3 );
 
 ## Notes
 
--   Let `M` be the number of generated values (which is either `N` or `N+1` depending on whether `endpoint` is `true` or `false`, respectively). The spacing between values is thus given by `Δ = (stop-start)/(M-1)`.
+-   Let `M` be the number of generated values (which is either `N` or `N+1` depending on whether `endpoint` is `true` or `false`, respectively). The spacing between values is thus given by
+
+    ```text
+    Δ = (stop-start)/(M-1)
+    ```
+
+-   When the number of generated values is greater than `1` and `endpoint` is `true`, the set of values written to a provided input array is guaranteed to include the `start` and `stop` values. Beware, however, that values between `start` and `stop` are subject to floating-point rounding errors. Hence,
+
+    ```javascript
+    var Float64Array = require( '@stdlib/array-float64' );
+
+    var x = new Float64Array( [ 0.0, 0.0, 0.0 ] );
+
+    dlinspace( 3, 0.0, 1.0, true, x, 1 );
+    // x => <Float64Array>[ 0.0, ~0.5, 1.0 ]
+    ```
+
+    where `x[1]` is only guaranteed to be approximately equal to `0.5`.
+
+-   When `N = 1` and `endpoint` is `false`, only the `start` value is written to a provided input array. When `N = 1` and `endpoint` is `true`, only the `stop` value is written to a provided input array.
+
+-   If `start < stop`, values are written to a provided input array in ascending order; otherwise, values are written in descending order.
+
 -   If `N <= 0`, both functions return `x` unchanged.
 
 </section>

docs/repl.txt

@@ -3,6 +3,20 @@
     Fills a double-precision floating-point strided array with linearly spaced
     values over a specified interval.
 
+    If `N = 1` and `endpoint` is `true`, the set of values written to an input
+    array only includes `stop`, but not `start`; otherwise, when `N = 1` and
+    `endpoint` is `false`, the set of values written to an input array only
+    includes `start`, but not `stop`.
+
+    If `start` is less than `stop`, the set of values written to an input array
+    will be written in ascending order, and, if `start` is greater than
+    `stop`, the set of written values will be in descending order.
+
+    When `N >= 2` and `endpoint` is `true`, the set of values written to an
+    input array is guaranteed to include the `start` and `stop` values. Beware,
+    however, that values between `start` and `stop` are subject to floating-
+    point rounding errors.
+
     The `N` and stride parameters determine which elements in the strided array
     are accessed at runtime.
 
@@ -24,7 +38,11 @@
 
     endpoint: boolean
         Boolean indicating whether to include the `stop` value when writing
-        values to the input array.
+        values to the input array. If `false`, the function generates `N+1`
+        linearly spaced values over the interval `[start, stop]` and only writes
+        `N` values to the input array, thus excluding `stop` from the input
+        array. Accordingly, for a fixed `N`, the spacing between adjacent values
+        written to an input array changes depending on the value of `endpoint`.
 
     x: Float64Array
         Input array.
@@ -79,7 +97,11 @@
 
     endpoint: boolean
         Boolean indicating whether to include the `stop` value when writing
-        values to the input array.
+        values to the input array. If `false`, the function generates `N+1`
+        linearly spaced values over the interval `[start, stop]` and only writes
+        `N` values to the input array, thus excluding `stop` from the input
+        array. Accordingly, for a fixed `N`, the spacing between adjacent values
+        written to an input array changes depending on the value of `endpoint`.
 
     x: Float64Array
         Input array.