Skip to content

Commit eb00b1b

Browse files
committed
docs: fix 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - 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: na - task: lint_license_headers status: passed ---
1 parent 985e111 commit eb00b1b

File tree

1 file changed

+4
-10
lines changed
  • lib/node_modules/@stdlib/array/base/one-to/lib

1 file changed

+4
-10
lines changed

lib/node_modules/@stdlib/array/base/one-to/lib/assign.js

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,23 +75,17 @@ function indexed( out, stride, offset ) {
7575
* @returns {(Complex128Array|Complex64Array)} output array
7676
*
7777
* @example
78-
* var Complex128Array = require( '@stdlib/array/complex128' );
7978
* var reinterpret128 = require( '@stdlib/strided/base/reinterpret-complex128' );
79+
* var Complex128Array = require( '@stdlib/array/complex128' );
8080
*
8181
* var out = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
82-
* // returns <Complex128Array>
82+
* // returns <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
8383
*
84-
* var data = reinterpret128( out, 0 );
85-
* // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
86-
*
87-
* var arr = complex( out, data, 1, 0 );
88-
* // returns <Complex128Array>
84+
* var arr = complex( out, reinterpret128( out, 0 ), 1, 0 );
85+
* // returns <Complex128Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]
8986
*
9087
* var bool = ( arr === out );
9188
* // returns true
92-
*
93-
* data = reinterpret128( out, 0 );
94-
* returns <Float64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ]
9589
*/
9690
function complex( out, data, stride, offset ) {
9791
var v;

0 commit comments

Comments
 (0)