Skip to content

docs: improve doctests for complex number instances in array/base/resolve-getter #8669

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
kgryte merged 4 commits into from
Dec 1, 2025
Merged

docs: improve doctests for complex number instances in array/base/resolve-getter #8669

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f4b62a
docs: improve doctests for complex number instances in array/base/res…
aryan7071 Nov 30, 2025
90b7df1
style: remove empty line
kgryte Dec 1, 2025
cd62d7d
style: remove empty line
kgryte Dec 1, 2025
62ac6d0
Merge remote-tracking branch 'upstream/develop' into docs/improve-doc…
stdlib-bot Dec 1, 2025
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
20 changes: 2 additions & 18 deletions lib/node_modules/@stdlib/array/base/resolve-getter/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,20 +191,12 @@ declare function resolveGetter( x: Float32Array ): GetFloat32;
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/array/real' );
* var imag = require( '@stdlib/array/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
*
* var get = resolveGetter( arr );
* var v = get( arr, 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 3.0
*
* var im = imag( v );
* // returns 4.0
* // returns <Complex128>[ 3.0, 4.0 ]
*/
declare function resolveGetter( x: Complex128Array ): GetComplex128;

Expand All @@ -216,20 +208,12 @@ declare function resolveGetter( x: Complex128Array ): GetComplex128;
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var realf = require( '@stdlib/array/realf' );
* var imagf = require( '@stdlib/array/imagf' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
* var get = resolveGetter( arr );
* var v = get( arr, 1 );
* // returns <Complex64>
*
* var re = realf( v );
* // returns 3.0
*
* var im = imagf( v );
* // returns 4.0
* // returns <Complex64>[ 3.0, 4.0 ]
*/
declare function resolveGetter( x: Complex64Array ): GetComplex64;

Expand Down