Skip to content

Commit 4c8449f

Browse files
docs: improve doctests for complex number instances in array/base/resolve-getter
PR-URL: #8695 Ref: #8641 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 5dfb3a9 commit 4c8449f

File tree

1 file changed

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

1 file changed

+2
-18
lines changed

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

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,6 @@ declare function resolveSetter( x: Float32Array ): SetFloat32;
201201
* var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
202202
* var Complex128Array = require( '@stdlib/array/complex128' );
203203
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
204-
* var real = require( '@stdlib/complex/float64/real' );
205-
* var imag = require( '@stdlib/complex/float64/imag' );
206204
*
207205
* var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
208206
*
@@ -211,13 +209,7 @@ declare function resolveSetter( x: Float32Array ): SetFloat32;
211209
*
212210
* var get = resolveGetter( arr );
213211
* var v = get( arr, 1 );
214-
* // returns <Complex128>
215-
*
216-
* var re = real( v );
217-
* // returns 10.0
218-
*
219-
* var im = imag( v );
220-
* // returns 11.0
212+
* // returns <Complex128>[ 10.0, 11.0 ]
221213
*/
222214
declare function resolveSetter( x: Complex128Array ): SetComplex128;
223215

@@ -231,8 +223,6 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
231223
* var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
232224
* var Complex64Array = require( '@stdlib/array/complex64' );
233225
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
234-
* var realf = require( '@stdlib/complex/float32/real' );
235-
* var imagf = require( '@stdlib/complex/float32/imag' );
236226
*
237227
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
238228
*
@@ -241,13 +231,7 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
241231
*
242232
* var get = resolveGetter( arr );
243233
* var v = get( arr, 1 );
244-
* // returns <Complex64>
245-
*
246-
* var re = realf( v );
247-
* // returns 10.0
248-
*
249-
* var im = imagf( v );
250-
* // returns 11.0
234+
* // returns <Complex64>[ 10.0, 11.0 ]
251235
*/
252236
declare function resolveSetter( x: Complex64Array ): SetComplex64;
253237

0 commit comments

Comments
 (0)