Skip to content

Commit 6b0e763

Browse files
authored
docs: update example and add return description
PR-URL: #2489 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 37ca4b7 commit 6b0e763

File tree

2 files changed

+4
-2
lines changed
  • lib/node_modules/@stdlib/array

2 files changed

+4
-2
lines changed

lib/node_modules/@stdlib/array/complex128/lib/main.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -906,6 +906,7 @@ setReadOnly( Complex128Array.prototype, 'every', function every( predicate, this
906906
* @throws {TypeError} first argument must be a complex number
907907
* @throws {TypeError} second argument must be an integer
908908
* @throws {TypeError} third argument must be an integer
909+
* @returns {Complex128Array} modified array
909910
*
910911
* @example
911912
* var real = require( '@stdlib/complex/real' );
@@ -924,7 +925,7 @@ setReadOnly( Complex128Array.prototype, 'every', function every( predicate, this
924925
* var im = imag( z );
925926
* // returns 1.0
926927
*
927-
* z = arr.get( 1 );
928+
* z = arr.get( 2 );
928929
* // returns <Complex128>
929930
*
930931
* re = real( z );

lib/node_modules/@stdlib/array/complex64/lib/main.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -900,6 +900,7 @@ setReadOnly( Complex64Array.prototype, 'every', function every( predicate, thisA
900900
* @throws {TypeError} first argument must be a complex number
901901
* @throws {TypeError} second argument must be an integer
902902
* @throws {TypeError} third argument must be an integer
903+
* @returns {Complex64Array} modified array
903904
*
904905
* @example
905906
* var realf = require( '@stdlib/complex/realf' );
@@ -918,7 +919,7 @@ setReadOnly( Complex64Array.prototype, 'every', function every( predicate, thisA
918919
* var im = imagf( z );
919920
* // returns 1.0
920921
*
921-
* z = arr.get( 1 );
922+
* z = arr.get( 2 );
922923
* // returns <Complex64>
923924
*
924925
* re = realf( z );

0 commit comments

Comments
 (0)