Skip to content

Commit 985e111

Browse files
committed
docs: refactor example
--- 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: passed - 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: na - task: lint_license_headers status: passed ---
1 parent ff3ffda commit 985e111

File tree

2 files changed

+4
-20
lines changed

2 files changed

+4
-20
lines changed

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

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,24 +73,16 @@ var out = first( x );
7373

7474
```javascript
7575
var Complex64Array = require( '@stdlib/array/complex64' );
76-
var realf = require( '@stdlib/complex/float32/real' );
77-
var imagf = require( '@stdlib/complex/float32/imag' );
7876
var first = require( '@stdlib/array/base/first' );
7977

8078
// Create a complex number array:
8179
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
8280

8381
// Return the first element:
8482
var out = first( arr );
85-
// returns <Complex64>
83+
// returns <Complex64>[ 1.0, 2.0 ]
8684

87-
var re = realf( out );
88-
// returns 1.0
89-
90-
var im = imagf( out );
91-
// returns 2.0
92-
93-
console.log( '%d + %di', re, im );
85+
console.log( '%s', out.toString() );
9486
// => '1 + 2i'
9587
```
9688

lib/node_modules/@stdlib/array/base/first/examples/index.js

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,14 @@
1919
'use strict';
2020

2121
var Complex64Array = require( '@stdlib/array/complex64' );
22-
var realf = require( '@stdlib/complex/float32/real' );
23-
var imagf = require( '@stdlib/complex/float32/imag' );
2422
var first = require( './../lib' );
2523

2624
// Create a complex number array:
2725
var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2826

2927
// Return the first element:
3028
var out = first( arr );
31-
// returns <Complex64>
29+
// returns <Complex64>[ 1.0, 2.0 ]
3230

33-
var re = realf( out );
34-
// returns 1.0
35-
36-
var im = imagf( out );
37-
// returns 2.0
38-
39-
console.log( '%d + %di', re, im );
31+
console.log( '%s', out.toString() );
4032
// => '1 + 2i'

0 commit comments

Comments
 (0)