Skip to content

Commit 83a1f45

Browse files
docs: improve doctests for complex number
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 3d6912d commit 83a1f45

1 file changed

Lines changed: 2 additions & 17 deletions

File tree

  • lib/node_modules/@stdlib/array/base/resolve-setter/docs/types

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

Lines changed: 2 additions & 17 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,8 @@ declare function resolveSetter( x: Float32Array ): SetFloat32;
211209
*
212210
* var get = resolveGetter( arr );
213211
* var v = get( arr, 1 );
214-
* // returns <Complex128>
212+
* // returns <Complex128>[ 10.0, 11.0 ]
215213
*
216-
* var re = real( v );
217-
* // returns 10.0
218-
*
219-
* var im = imag( v );
220-
* // returns 11.0
221214
*/
222215
declare function resolveSetter( x: Complex128Array ): SetComplex128;
223216

@@ -231,8 +224,6 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
231224
* var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
232225
* var Complex64Array = require( '@stdlib/array/complex64' );
233226
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
234-
* var realf = require( '@stdlib/complex/float32/real' );
235-
* var imagf = require( '@stdlib/complex/float32/imag' );
236227
*
237228
* var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
238229
*
@@ -241,13 +232,7 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
241232
*
242233
* var get = resolveGetter( arr );
243234
* 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
235+
* // returns <Complex64>[ 10.0, 11.0 ]
251236
*/
252237
declare function resolveSetter( x: Complex64Array ): SetComplex64;
253238

0 commit comments

Comments
 (0)