Skip to content

Commit 0070594

Browse files
committed
docs: improve doctests for complex number instances in array/base/accessors
--- 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: passed - 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 03405cc commit 0070594

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

lib/node_modules/@stdlib/array/base/accessors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ console.log( 'Accessor protocol: %s', bool );
115115

116116
// Retrieve an array element:
117117
var v = obj.accessors[ 0 ]( x, 1 );
118-
// returns <Complex64>
118+
// returns <Complex64>[ 2.0, 3.0 ]
119119

120120
console.log( 'x[1] = %s', v.toString() );
121121
```

lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -761,7 +761,7 @@ declare function accessors( x: Uint8ClampedArray ): Uint8cAccessorObject;
761761
* // returns [ <Function>, <Function> ]
762762
*
763763
* var v = fcns[ 0 ]( x, 1 );
764-
* // returns <Complex128>
764+
* // returns <Complex128>[ 3.0, 4.0 ]
765765
*/
766766
declare function accessors( x: Complex128Array ): Complex128AccessorObject;
767767

@@ -789,7 +789,7 @@ declare function accessors( x: Complex128Array ): Complex128AccessorObject;
789789
* // returns [ <Function>, <Function> ]
790790
*
791791
* var v = fcns[ 0 ]( x, 1 );
792-
* // returns <Complex64>
792+
* // returns <Complex64>[ 3.0, 4.0 ]
793793
*/
794794
declare function accessors( x: Complex64Array ): Complex64AccessorObject;
795795

0 commit comments

Comments
 (0)