Skip to content

Commit e59b60d

Browse files
committed
Auto-generated commit
1 parent b864612 commit e59b60d

2 files changed

Lines changed: 6 additions & 21 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,6 +929,7 @@ A total of 49 issues were closed in this release:
929929

930930
<details>
931931

932+
- [`39693af`](https://github.com/stdlib-js/stdlib/commit/39693afb2e34914d2dec876faf3af05390827b6b) - **docs:** improve doctests for complex number typed arrays in `ndarray/from-scalar` [(#12043)](https://github.com/stdlib-js/stdlib/pull/12043) _(by Karan Anand)_
932933
- [`1674c38`](https://github.com/stdlib-js/stdlib/commit/1674c3865eca607df401b7ccebea4873fba422c0) - **docs:** improve doctests for complex number typed arrays in `ndarray/filter-map` [(#12042)](https://github.com/stdlib-js/stdlib/pull/12042) _(by Karan Anand)_
933934
- [`0e2b5a5`](https://github.com/stdlib-js/stdlib/commit/0e2b5a5e9dec8520a7e6676876aae915c4b2ab2c) - **feat:** add `descriptor` to namespace _(by Athan Reines)_
934935
- [`b5d65f3`](https://github.com/stdlib-js/stdlib/commit/b5d65f3863b2d9bcee6f6dbfc53fff58a10380d4) - **feat:** add `ndarray/base/descriptor` _(by Athan Reines)_

from-scalar/docs/types/index.d.ts

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,6 @@ declare function scalar2ndarray( value: number, options: Float32Options ): float
229229
*
230230
* @example
231231
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
232-
* var real = require( '@stdlib/complex/float64/real' );
233-
* var imag = require( '@stdlib/complex/float64/imag' );
234232
*
235233
* var v = new Complex128( 1.0, 2.0 );
236234
*
@@ -245,14 +243,8 @@ declare function scalar2ndarray( value: number, options: Float32Options ): float
245243
* var dt = x.dtype;
246244
* // returns 'complex128'
247245
*
248-
* var v = x.get();
249-
* // returns <Complex128>
250-
*
251-
* var re = real( v );
252-
* // returns 1.0
253-
*
254-
* var im = imag( v );
255-
* // returns 2.0
246+
* var buf = x.data;
247+
* // buf => <Complex128Array>[ 1.0, 2.0 ]
256248
*/
257249
declare function scalar2ndarray( value: number | ComplexLike, options: Complex128Options ): complex128ndarray;
258250

@@ -268,9 +260,7 @@ declare function scalar2ndarray( value: number | ComplexLike, options: Complex12
268260
* @returns zero-dimensional ndarray
269261
*
270262
* @example
271-
* var Complex64 = require( '@stdlib/complex/float64/ctor' );
272-
* var realf = require( '@stdlib/complex/float32/real' );
273-
* var imagf = require( '@stdlib/complex/float32/imag' );
263+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
274264
*
275265
* var v = new Complex64( 1.0, 2.0 );
276266
*
@@ -285,14 +275,8 @@ declare function scalar2ndarray( value: number | ComplexLike, options: Complex12
285275
* var dt = x.dtype;
286276
* // returns 'complex64'
287277
*
288-
* var v = x.get();
289-
* // returns <Complex64>
290-
*
291-
* var re = realf( v );
292-
* // returns 1.0
293-
*
294-
* var im = imagf( v );
295-
* // returns 2.0
278+
* var buf = x.data;
279+
* // buf => <Complex64Array>[ 1.0, 2.0 ]
296280
*/
297281
declare function scalar2ndarray( value: number | ComplexLike, options: Complex64Options ): complex64ndarray;
298282

0 commit comments

Comments
 (0)