Skip to content

docs: improve doctests for complex number instances in ndarray/base/broadcast-scalar #8869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Dec 8, 2025
Merged

docs: improve doctests for complex number instances in ndarray/base/broadcast-scalar #8869

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfb9559
docs: improve doctests for complex number instances in ndarray/base/b…
ashutoshsao Dec 7, 2025
e39bf01
style: add missing space
kgryte Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,6 @@
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var v = new Complex128( 1.0, 2.0 );
*
Expand All @@ -109,13 +107,7 @@
* // returns 'complex128'
*
* var v = x.get( 0, 1 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 1.0
*
* var im = imag( v );
* // returns 2.0
* // returns <Complex128>[ 1.0, 2.0 ]
*/
declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray;

Expand Down Expand Up @@ -375,7 +367,7 @@
* var v = x.get( 0, 1 );
* // returns 1.0
*/
declare function broadcastScalar( value: any, dtype: DataType, shape: Shape, order: Order ): ndarray;

Check warning on line 370 in lib/node_modules/@stdlib/ndarray/base/broadcast-scalar/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected any. Specify a different type


// EXPORTS //
Expand Down