Skip to content

Commit 3f7b1ed

Browse files
committed
docs: fix code in TSDoc examples
--- 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 54dada5 commit 3f7b1ed

File tree

16 files changed

+77
-76
lines changed

16 files changed

+77
-76
lines changed

lib/node_modules/@stdlib/array/base/unary4d-by/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ type Unary<U, V> = ( value: U ) => V;
104104
* var x = ones4d( shape );
105105
* var y = zeros4d( shape );
106106
*
107-
* unary4dBy( [ x, y ], shape, scale );
107+
* unary4dBy( [ x, y ], shape, scale, accessor );
108108
*
109109
* console.log( y );
110110
* // => [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ]

lib/node_modules/@stdlib/blas/base/gger/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ interface Routine {
106106
* var x = [ 1.0, 1.0 ];
107107
* var y = [ 1.0, 1.0, 1.0 ];
108108
*
109-
* gger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 2 );
109+
* gger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 );
110110
* // A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ]
111111
*
112112
* @example

lib/node_modules/@stdlib/blas/base/srotm/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ interface Routine {
4141
* var param = new Float32Array( [ 0.0, 0.0, 2.0, -3.0, 0.0 ] );
4242
*
4343
* srotm( 4, x, -1, y, -2, param );
44-
* // x => <Float32Array>[ -0.9, -0.8, 1.3, -1.6, 0.9, -0.3, -0.4 ]
44+
* // x => <Float32Array>[ ~-0.9, ~-0.8, ~1.3, ~-1.6, ~0.9, ~-0.3, ~-0.4 ]
4545
* // y => <Float32Array>[ 1.7, -0.9, 0.5, 0.7, -1.6, 0.2, 2.4 ]
4646
*/
4747
( N: number, x: Float32Array, strideX: number, y: Float32Array, strideY: number, param: Float32Array ): Float32Array;
@@ -68,7 +68,7 @@ interface Routine {
6868
* var param = new Float32Array( [ 0.0, 0.0, 2.0, -3.0, 0.0 ] );
6969
*
7070
* srotm.ndarray( 4, x, -1, 3, y, -2, 6, param );
71-
* // x => <Float32Array>[ -0.9, -0.8, 1.3, -1.6, 0.9, -0.3, -0.4 ]
71+
* // x => <Float32Array>[ ~-0.9, ~-0.8, ~1.3, ~-1.6, ~0.9, ~-0.3, ~-0.4 ]
7272
* // y => <Float32Array>[ 1.7, -0.9, 0.5, 0.7, -1.6, 0.2, 2.4 ]
7373
*/
7474
ndarray( N: number, x: Float32Array, strideX: number, offsetX: number, y: Float32Array, strideY: number, offsetY: number, param: Float32Array ): Float32Array;

lib/node_modules/@stdlib/blas/base/wasm/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -808,7 +808,7 @@ interface Namespace {
808808
* var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
809809
*
810810
* ns.srot( 3, x, 2, y, 2, 0.8, 0.6 );
811-
* // x => <Float32Array>[ 5.0, 2.0, ~7.8, 4.0, ~10.6, 6.0 ]
811+
* // x => <Float32Array>[ ~5.0, 2.0, ~7.8, 4.0, ~10.6, 6.0 ]
812812
* // y => <Float32Array>[ 5.0, 8.0, ~5.4, 10.0, ~5.8, 12.0 ]
813813
*
814814
* @example

lib/node_modules/@stdlib/ndarray/empty-like/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1252,7 +1252,7 @@ declare function emptyLike( x: ndarray, options: GenericOptions ): genericndarra
12521252
* // returns [ 2, 2 ]
12531253
*
12541254
* var dt = x.dtype;
1255-
* // returns 'generic'
1255+
* // returns 'float64'
12561256
*
12571257
* var y = emptyLike( x );
12581258
* // returns <ndarray>
@@ -1261,7 +1261,7 @@ declare function emptyLike( x: ndarray, options: GenericOptions ): genericndarra
12611261
* // returns [ 2, 2 ]
12621262
*
12631263
* dt = y.dtype;
1264-
* // returns 'generic'
1264+
* // returns 'float64'
12651265
*/
12661266
declare function emptyLike( x: ndarray, options?: Options | OptionsWithDType ): typedndarray<number>;
12671267

lib/node_modules/@stdlib/ndarray/fill-by/docs/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ type Callback<T, U, V, ThisArg> = Nullary<U, ThisArg> | Unary<T, U, ThisArg> | B
7777
* @example
7878
* var zeros = require( '@stdlib/ndarray/zeros' );
7979
* var getData = require( '@stdlib/ndarray/data-buffer' );
80+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
8081
*
8182
* function fcn() {
8283
* return new Complex128( 10.0, 0.0 );

lib/node_modules/@stdlib/ndarray/filter-map/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@ declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarr
13481348
* var ndarray = require( '@stdlib/ndarray/ctor' );
13491349
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
13501350
*
1351-
* function fcn( z ) {
1351+
* function fcn( z, idx ) {
13521352
* if ( idx[ 0 ] > 0 ) {
13531353
* return new Complex128( z, 0.0 );
13541354
* }
@@ -1386,7 +1386,7 @@ declare function filterMap<T = unknown, U = unknown, V = unknown>( x: typedndarr
13861386
* var ndarray = require( '@stdlib/ndarray/ctor' );
13871387
* var Complex64 = require( '@stdlib/complex/float64/ctor' );
13881388
*
1389-
* function fcn( z ) {
1389+
* function fcn( z, idx ) {
13901390
* if ( idx[ 0 ] > 0 ) {
13911391
* return new Complex64( z, 0.0 );
13921392
* }

lib/node_modules/@stdlib/ndarray/vector/bool/docs/types/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface BooleanVector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 32, 8 );
154-
* var arr = new BooleanVector( buf );
153+
* var buf = new ArrayBuffer( 32 );
154+
* var arr = new BooleanVector( buf, 8 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface BooleanVector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 32, 8, 2 );
179-
* var arr = new BooleanVector( buf );
178+
* var buf = new ArrayBuffer( 32 );
179+
* var arr = new BooleanVector( buf, 8, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface BooleanVector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 32, 8 );
288-
* var arr = new BooleanVector( buf );
287+
* var buf = new ArrayBuffer( 32 );
288+
* var arr = new BooleanVector( buf, 8 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface BooleanVector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 32, 8, 2 );
313-
* var arr = new BooleanVector( buf );
312+
* var buf = new ArrayBuffer( 32 );
313+
* var arr = new BooleanVector( buf, 8, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

lib/node_modules/@stdlib/ndarray/vector/complex128/docs/types/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface Complex128Vector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 64, 16 );
154-
* var arr = new Complex128Vector( buf );
153+
* var buf = new ArrayBuffer( 64 );
154+
* var arr = new Complex128Vector( buf, 16 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface Complex128Vector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 64, 16, 2 );
179-
* var arr = new Complex128Vector( buf );
178+
* var buf = new ArrayBuffer( 64 );
179+
* var arr = new Complex128Vector( buf, 16, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface Complex128Vector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 64, 16 );
288-
* var arr = new Complex128Vector( buf );
287+
* var buf = new ArrayBuffer( 64 );
288+
* var arr = new Complex128Vector( buf, 16 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface Complex128Vector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 64, 16, 2 );
313-
* var arr = new Complex128Vector( buf );
312+
* var buf = new ArrayBuffer( 64 );
313+
* var arr = new Complex128Vector( buf, 16, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

lib/node_modules/@stdlib/ndarray/vector/complex64/docs/types/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface Complex64Vector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 32, 8 );
154-
* var arr = new Complex64Vector( buf );
153+
* var buf = new ArrayBuffer( 32);
154+
* var arr = new Complex64Vector( buf, 8 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface Complex64Vector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 32, 8, 2 );
179-
* var arr = new Complex64Vector( buf );
178+
* var buf = new ArrayBuffer( 32 );
179+
* var arr = new Complex64Vector( buf, 8, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface Complex64Vector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 32, 8 );
288-
* var arr = new Complex64Vector( buf );
287+
* var buf = new ArrayBuffer( 32 );
288+
* var arr = new Complex64Vector( buf, 8 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface Complex64Vector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 32, 8, 2 );
313-
* var arr = new Complex64Vector( buf );
312+
* var buf = new ArrayBuffer( 32 );
313+
* var arr = new Complex64Vector( buf, 8, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

0 commit comments

Comments
 (0)