Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,18 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2026-04-23)
+## Unreleased (2026-04-27)
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`8b687a9`](https://github.com/stdlib-js/stdlib/commit/8b687a9fcb935144ef3a544458e33830c95dc3df) - **docs:** update descriptions _(by Athan Reines)_
+-   [`bdc1f9b`](https://github.com/stdlib-js/stdlib/commit/bdc1f9beed8120b36f6cb9fae9a5f28c091654f1) - **docs:** add notes _(by Athan Reines)_
+-   [`f5a9f7d`](https://github.com/stdlib-js/stdlib/commit/f5a9f7d31e7d8877e5e3556533382e8e7e02c58e) - **docs:** update descriptions _(by Athan Reines)_
+-   [`be5b88f`](https://github.com/stdlib-js/stdlib/commit/be5b88f6f8b66169d6a849762671816069e2a95c) - **docs:** update copy _(by Athan Reines)_
 -   [`0779fd4`](https://github.com/stdlib-js/stdlib/commit/0779fd40d190cee898a170518996788f07d1e755) - **chore:** modernize examples and benchmarks _(by Athan Reines)_
 -   [`39db70f`](https://github.com/stdlib-js/stdlib/commit/39db70f0446038735b98e82abc26b369ac34938f) - **bench:** refactor to use string interpolation in `@stdlib/blas` [(#11397)](https:-/github.com/stdlib-js/stdlib/pull/11397) _(by Karan Anand)_
 -   [`04fd54f`](https://github.com/stdlib-js/stdlib/commit/04fd54f42c8c1b0af88660d7ce791f71891a2187) - **refactor:** improve type specificity in `blas/base/ndarray/gdot` [(#11245)](https://github.com/stdlib-js/stdlib/pull/11245) _(by Kaustubh Patange)_

README.md

@@ -100,10 +100,10 @@ var z = gdot( [ x, y ] );
 
 The function has the following parameters:
 
--   **arrays**: array-like object containing the following ndarrays in order:
+-   **arrays**: array-like object containing the following ndarrays:
 
-    -   first input ndarray
-    -   second input ndarray
+    -   first one-dimensional input ndarray.
+    -   second one-dimensional input ndarray.
 
 </section>
 

dist/index.js.map

@@ -7,7 +7,10 @@
     Parameters
     ----------
     arrays: ArrayLikeObject<ndarray>
-        Array-like object containing two one-dimensional input ndarrays.
+        Array-like object containing the following ndarrays:
+
+        - first one-dimensional input ndarray.
+        - second one-dimensional input ndarray.
 
     Returns
     -------

docs/repl.txt

@@ -25,7 +25,14 @@ import { typedndarray } from '@stdlib/types/ndarray';
 /**
 * Computes the dot product of two one-dimensional ndarrays.
 *
-* @param arrays - array-like object containing two one-dimensional input ndarrays
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   first one-dimensional input ndarray.
+*     -   second one-dimensional input ndarray.
+*
+* @param arrays - array-like object containing ndarrays
 * @returns dot product
 *
 * @example

docs/types/index.d.ts

@@ -32,7 +32,14 @@ var strided = require( '@stdlib/blas-base-gdot' ).ndarray;
 /**
 * Computes the dot product of two one-dimensional ndarrays.
 *
-* @param {ArrayLikeObject<Object>} arrays - array-like object containing two one-dimensional input ndarrays
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   first one-dimensional input ndarray.
+*     -   second one-dimensional input ndarray.
+*
+* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
 * @returns {number} dot product
 *
 * @example