Skip to content

docs: update example and add return description #2489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 1, 2024
Merged

docs: update example and add return description #2489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lib/node_modules/@stdlib/array/complex128/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand All @@ -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 );
Expand Down
3 changes: 2 additions & 1 deletion lib/node_modules/@stdlib/array/complex64/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand All @@ -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 );
Expand Down