Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -598,6 +598,9 @@ A total of 26 issues were closed in this release:
 
 <details>
 
+-   [`08a671a`](https://github.com/stdlib-js/stdlib/commit/08a671a9e339db0bfbd5953891c9a9c3e1f5beb2) - **docs:** add note _(by Athan Reines)_
+-   [`e49d1a0`](https://github.com/stdlib-js/stdlib/commit/e49d1a00ad07054f006f0a9a3fd52dbce217ea84) - **docs:** add note _(by Athan Reines)_
+-   [`4583470`](https://github.com/stdlib-js/stdlib/commit/45834700742e84b03646e769e94d498ee66c65b4) - **docs:** add note _(by Athan Reines)_
 -   [`d55cb4b`](https://github.com/stdlib-js/stdlib/commit/d55cb4bbda9f3810f92a2535fdbb60a62c60e161) - **docs:** add missing decimals _(by Athan Reines)_
 -   [`607adbe`](https://github.com/stdlib-js/stdlib/commit/607adbe9aba4c11a689408c62930ca3901db5f7d) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`29d3bbb`](https://github.com/stdlib-js/stdlib/commit/29d3bbb5241884d149b000c3a76d59227686728f) - **chore:** fix C lint errors [(#8157)](https://github.com/stdlib-js/stdlib/pull/8157) _(by GeoDaoyu, Athan Reines)_

base/pop/README.md

@@ -71,7 +71,7 @@ arr = ndarray2array( y[ 1 ] );
 
 The function accepts the following arguments:
 
--   **x**: input ndarray.
+-   **x**: input ndarray. Must have one or more dimensions.
 -   **dim**: dimension along which to perform the operation. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
 -   **writable**: boolean indicating whether a returned ndarray should be writable.
 

base/pop/docs/repl.txt

@@ -6,7 +6,7 @@
     Parameters
     ----------
     x: ndarray
-        Input ndarray.
+        Input ndarray. Must have one or more dimensions.
 
     dim: integer
         Dimension along which to perform the operation. If provided an integer

base/pop/docs/types/index.d.ts

@@ -25,6 +25,10 @@ import { ndarray } from '@stdlib/types/ndarray';
 /**
 * Returns an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.
 *
+* ## Notes
+*
+* -   The input array must have one or more dimensions.
+*
 * @param x - input array
 * @param dim - dimension along which to perform the operation
 * @param writable - boolean indicating whether returned arrays should be writable

base/shift/README.md

@@ -71,7 +71,7 @@ arr = ndarray2array( y[ 1 ] );
 
 The function accepts the following arguments:
 
--   **x**: input ndarray.
+-   **x**: input ndarray. Must have one or more dimensions.
 -   **dim**: dimension along which to perform the operation. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
 -   **writable**: boolean indicating whether a returned ndarray should be writable.
 

base/shift/docs/repl.txt

@@ -6,7 +6,7 @@
     Parameters
     ----------
     x: ndarray
-        Input array.
+        Input array. Must have one or more dimensions.
 
     dim: integer
         Dimension along which to perform the operation. If provided an integer

base/shift/docs/types/index.d.ts

@@ -26,6 +26,10 @@ import { ndarray } from '@stdlib/types/ndarray';
 /**
 * Returns an array containing a truncated view of an input ndarray and a view of the first element(s) along a specified dimension.
 *
+* ## Notes
+*
+* -   The input array must have one or more dimensions.
+*
 * @param x - input array
 * @param dim - dimension along which to perform the operation
 * @param writable - boolean indicating whether returned arrays should be writable

pop/README.md

@@ -68,7 +68,7 @@ arr = ndarray2array( y[ 1 ] );
 
 The function accepts the following arguments:
 
--   **x**: input ndarray.
+-   **x**: input ndarray. Must have one or more dimensions.
 -   **options**: function options. (_optional_)
 
 The function supports the following `options`:

pop/docs/repl.txt

@@ -6,7 +6,7 @@
     Parameters
     ----------
     x: ndarray
-        Input ndarray.
+        Input ndarray. Must have one or more dimensions.
 
     options: Object (optional)
         Options.

pop/docs/types/index.d.ts

@@ -39,6 +39,10 @@ interface Options {
 /**
 * Returns an array containing a read-only truncated view of an input ndarray and a read-only view of the last element(s) along a specified dimension.
 *
+* ## Notes
+*
+* -   The input array must have one or more dimensions.
+*
 * @param x - input array
 * @param options - function options
 * @param options.dim - dimension along which to perform the operation