Skip to content

Commit dfb9559

Browse files
committed
docs: improve doctests for complex number instances in ndarray/base/broadcast-scalar
--- 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 fea0656 commit dfb9559

File tree

1 file changed

+1
-9
lines changed
  • lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/docs/types

1 file changed

+1
-9
lines changed

lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/docs/types/index.d.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,6 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
9494
* var getShape = require( '@stdlib/ndarray/shape' );
9595
* var getDType = require( '@stdlib/ndarray/dtype' );
9696
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
97-
* var real = require( '@stdlib/complex/float64/real' );
98-
* var imag = require( '@stdlib/complex/float64/imag' );
9997
*
10098
* var v = new Complex128( 1.0, 2.0 );
10199
*
@@ -109,13 +107,7 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
109107
* // returns 'complex128'
110108
*
111109
* var v = x.get( 0, 1 );
112-
* // returns <Complex128>
113-
*
114-
* var re = real( v );
115-
* // returns 1.0
116-
*
117-
* var im = imag( v );
118-
* // returns 2.0
110+
* // returns <Complex128>[ 1.0,2.0 ]
119111
*/
120112
declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray;
121113

0 commit comments

Comments
 (0)