Skip to content

Commit 367ec2c

Browse files
authored
docs: update namespace TypeScript declarations
PR-URL: #5039 Reviewed-by: Athan Reines <[email protected]>
1 parent 1d6c6cf commit 367ec2c

File tree

3 files changed

+15
-51
lines changed

3 files changed

+15
-51
lines changed

Diff for: lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts

+6-42
Original file line numberDiff line numberDiff line change
@@ -255,59 +255,23 @@ interface Namespace {
255255
*
256256
* @example
257257
* var Complex64Array = require( '@stdlib/array/complex64' );
258-
* var realf = require( '@stdlib/complex/float32/real' );
259-
* var imagf = require( '@stdlib/complex/float32/imag' );
260258
*
261259
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
262-
* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
260+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
263261
*
264262
* ns.cswap( x.length, x, 1, y, 1 );
265-
*
266-
* var z = y.get( 0 );
267-
* // returns <Complex64>
268-
*
269-
* var re = realf( z );
270-
* // returns 1.0
271-
*
272-
* var im = imagf( z );
273-
* // returns 2.0
274-
*
275-
* z = x.get( 0 );
276-
* // returns <Complex64>
277-
*
278-
* re = realf( z );
279-
* // returns 7.0
280-
*
281-
* im = imagf( z );
282-
* // returns 8.0
263+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
264+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
283265
*
284266
* @example
285267
* var Complex64Array = require( '@stdlib/array/complex64' );
286-
* var realf = require( '@stdlib/complex/float32/real' );
287-
* var imagf = require( '@stdlib/complex/float32/imag' );
288268
*
289269
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
290-
* var y = new Complex64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
270+
* var y = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
291271
*
292272
* ns.cswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
293-
*
294-
* var z = y.get( 0 );
295-
* // returns <Complex64>
296-
*
297-
* var re = realf( z );
298-
* // returns 1.0
299-
*
300-
* var im = imagf( z );
301-
* // returns 2.0
302-
*
303-
* z = x.get( 0 );
304-
* // returns <Complex64>
305-
*
306-
* re = realf( z );
307-
* // returns 7.0
308-
*
309-
* im = imagf( z );
310-
* // returns 8.0
273+
* // x => <Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
274+
* // y => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
311275
*/
312276
cswap: typeof cswap;
313277

Diff for: lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -2596,12 +2596,12 @@ interface Namespace {
25962596
scusumpw: typeof scusumpw;
25972597

25982598
/**
2599-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation.
2599+
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using extended accumulation.
26002600
*
26012601
* @param N - number of indexed elements
2602-
* @param alpha - constant
2602+
* @param alpha - scalar constant
26032603
* @param x - input array
2604-
* @param stride - stride length
2604+
* @param strideX - stride length
26052605
* @returns sum
26062606
*
26072607
* @example
@@ -2654,7 +2654,7 @@ interface Namespace {
26542654
*
26552655
* @param N - number of indexed elements
26562656
* @param x - input array
2657-
* @param stride - stride length
2657+
* @param strideX - stride length
26582658
* @returns sum
26592659
*
26602660
* @example
@@ -2706,7 +2706,7 @@ interface Namespace {
27062706
*
27072707
* @param N - number of indexed elements
27082708
* @param x - input array
2709-
* @param stride - stride length
2709+
* @param strideX - stride length
27102710
* @returns sum
27112711
*
27122712
* @example
@@ -2785,7 +2785,7 @@ interface Namespace {
27852785
*
27862786
* @param N - number of indexed elements
27872787
* @param x - input array
2788-
* @param stride - stride length
2788+
* @param strideX - stride length
27892789
* @returns sum
27902790
*
27912791
* @example
@@ -3145,7 +3145,7 @@ interface Namespace {
31453145
*
31463146
* @param N - number of indexed elements
31473147
* @param x - input array
3148-
* @param stride - stride length
3148+
* @param strideX - stride length
31493149
* @returns sum
31503150
*
31513151
* @example
@@ -3197,7 +3197,7 @@ interface Namespace {
31973197
*
31983198
* @param N - number of indexed elements
31993199
* @param x - input array
3200-
* @param stride - stride length
3200+
* @param strideX - stride length
32013201
* @returns sum
32023202
*
32033203
* @example

Diff for: lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2609,7 +2609,7 @@ interface Namespace {
26092609
*
26102610
* @param N - number of indexed elements
26112611
* @param x - input array
2612-
* @param stride - stride length
2612+
* @param strideX - stride length
26132613
* @returns maximum value
26142614
*
26152615
* @example

0 commit comments

Comments
 (0)