Skip to content

Commit d07452d

Browse files
aryan7071kgrytestdlib-bot
authored
docs: improve doctests for complex number instances in array/base/resolve-getter
PR-URL: #8669 Ref: #8641 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Co-authored-by: stdlib-bot <noreply@stdlib.io>
1 parent 95d33f1 commit d07452d

File tree

1 file changed

+2
-18
lines changed
  • lib/node_modules/@stdlib/array/base/resolve-getter/docs/types

1 file changed

+2
-18
lines changed

lib/node_modules/@stdlib/array/base/resolve-getter/docs/types/index.d.ts

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -191,20 +191,12 @@ declare function resolveGetter( x: Float32Array ): GetFloat32;
191191
*
192192
* @example
193193
* var Complex128Array = require( '@stdlib/array/complex128' );
194-
* var real = require( '@stdlib/array/real' );
195-
* var imag = require( '@stdlib/array/imag' );
196194
*
197195
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
198196
*
199197
* var get = resolveGetter( arr );
200198
* var v = get( arr, 1 );
201-
* // returns <Complex128>
202-
*
203-
* var re = real( v );
204-
* // returns 3.0
205-
*
206-
* var im = imag( v );
207-
* // returns 4.0
199+
* // returns <Complex128>[ 3.0, 4.0 ]
208200
*/
209201
declare function resolveGetter( x: Complex128Array ): GetComplex128;
210202

@@ -216,20 +208,12 @@ declare function resolveGetter( x: Complex128Array ): GetComplex128;
216208
*
217209
* @example
218210
* var Complex64Array = require( '@stdlib/array/complex64' );
219-
* var realf = require( '@stdlib/array/realf' );
220-
* var imagf = require( '@stdlib/array/imagf' );
221211
*
222212
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
223213
*
224214
* var get = resolveGetter( arr );
225215
* var v = get( arr, 1 );
226-
* // returns <Complex64>
227-
*
228-
* var re = realf( v );
229-
* // returns 3.0
230-
*
231-
* var im = imagf( v );
232-
* // returns 4.0
216+
* // returns <Complex64>[ 3.0, 4.0 ]
233217
*/
234218
declare function resolveGetter( x: Complex64Array ): GetComplex64;
235219

0 commit comments

Comments
 (0)