docs: update example and add return description

PR-URL: #2489 Reviewed-by: Athan Reines <kgryte@gmail.com>
stdlib-js · Jul 1, 2024 · 6b0e763 · 6b0e763 · stdlib-bot · Jul 1, 2024
1 parent 37ca4b7
commit 6b0e763
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/lib/node_modules/@stdlib/array/complex128/lib/main.js b/lib/node_modules/@stdlib/array/complex128/lib/main.js
@@ -906,6 +906,7 @@ setReadOnly( Complex128Array.prototype, 'every', function every( predicate, this
 * @throws {TypeError} first argument must be a complex number
 * @throws {TypeError} second argument must be an integer
 * @throws {TypeError} third argument must be an integer
+* @returns {Complex128Array} modified array
 *
 * @example
 * var real = require( '@stdlib/complex/real' );
@@ -924,7 +925,7 @@ setReadOnly( Complex128Array.prototype, 'every', function every( predicate, this
 * var im = imag( z );
 * // returns 1.0
 *
-* z = arr.get( 1 );
+* z = arr.get( 2 );
 * // returns <Complex128>
 *
 * re = real( z );

diff --git a/lib/node_modules/@stdlib/array/complex64/lib/main.js b/lib/node_modules/@stdlib/array/complex64/lib/main.js
@@ -900,6 +900,7 @@ setReadOnly( Complex64Array.prototype, 'every', function every( predicate, thisA
 * @throws {TypeError} first argument must be a complex number
 * @throws {TypeError} second argument must be an integer
 * @throws {TypeError} third argument must be an integer
+* @returns {Complex64Array} modified array
 *
 * @example
 * var realf = require( '@stdlib/complex/realf' );
@@ -918,7 +919,7 @@ setReadOnly( Complex64Array.prototype, 'every', function every( predicate, thisA
 * var im = imagf( z );
 * // returns 1.0
 *
-* z = arr.get( 1 );
+* z = arr.get( 2 );
 * // returns <Complex64>
 *
 * re = realf( z );
Package	Statements	Branches	Functions	Lines
array/complex128	$\color{red}3317/3327$ $\color{green}+99.70\%$	$\color{red}528/536$ $\color{green}+98.51\%$	$\color{green}54/54$ $\color{green}+100.00\%$	$\color{red}3317/3327$ $\color{green}+99.70\%$
array/complex64	$\color{red}3315/3325$ $\color{green}+99.70\%$	$\color{red}526/534$ $\color{green}+98.50\%$	$\color{green}54/54$ $\color{green}+100.00\%$	$\color{red}3315/3325$ $\color{green}+99.70\%$