Skip to content

Commit e62f498

Browse files
PlaneshifterPlaneshifter
committed
docs: fix example code and return annotations 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 f870646 commit e62f498

File tree

10 files changed

+32
-32
lines changed

10 files changed

+32
-32
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ interface Routine extends ModuleWrapper {
218218
*
219219
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
220220
*
221-
* var out = dasum.main( x.length, 5.0, x, 1, y, 1 );
221+
* var out = dasum.main( x.length, x, 1 );
222222
* // returns 15.0
223223
*/
224224
main( N: number, x: Float64Array, strideX: number ): number;

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ interface ModuleConstructor {
7575
*
7676
* // Read out the results:
7777
* var viewX = zeros( N, dtype );
78-
* var viewY = zeros( n, dtype );
78+
* var viewY = zeros( N, dtype );
7979
* mod.read( xptr, viewX )
8080
* mod.read( yptr, viewY );
8181
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -132,7 +132,7 @@ interface ModuleConstructor {
132132
*
133133
* // Read out the results:
134134
* var viewX = zeros( N, dtype );
135-
* var viewY = zeros( n, dtype );
135+
* var viewY = zeros( N, dtype );
136136
* mod.read( xptr, viewX )
137137
* mod.read( yptr, viewY );
138138
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -198,7 +198,7 @@ interface Module extends ModuleWrapper {
198198
*
199199
* // Read out the results:
200200
* var viewX = zeros( N, dtype );
201-
* var viewY = zeros( n, dtype );
201+
* var viewY = zeros( N, dtype );
202202
* mod.read( xptr, viewX )
203203
* mod.read( yptr, viewY );
204204
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -261,7 +261,7 @@ interface Module extends ModuleWrapper {
261261
*
262262
* // Read out the results:
263263
* var viewX = zeros( N, dtype );
264-
* var viewY = zeros( n, dtype );
264+
* var viewY = zeros( N, dtype );
265265
* mod.read( xptr, viewX )
266266
* mod.read( yptr, viewY );
267267
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -369,7 +369,7 @@ interface Routine extends ModuleWrapper {
369369
*
370370
* // Read out the results:
371371
* var viewX = zeros( N, dtype );
372-
* var viewY = zeros( n, dtype );
372+
* var viewY = zeros( N, dtype );
373373
* mod.read( xptr, viewX )
374374
* mod.read( yptr, viewY );
375375
* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ interface Routine extends ModuleWrapper {
222222
*
223223
* // Perform operation:
224224
* var out = dznrm2.main( x.length, x, 1 );
225-
* // returns ~9.53
225+
* // returns ~9.54
226226
*/
227227
main( N: number, x: Complex128Array, strideX: number ): number;
228228

@@ -242,7 +242,7 @@ interface Routine extends ModuleWrapper {
242242
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
243243
*
244244
* var out = dznrm2.ndarray( x.length, x, 1, 0 );
245-
* // returns ~9.53
245+
* // returns ~9.54
246246
*/
247247
ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number ): number;
248248

@@ -303,7 +303,7 @@ interface Routine extends ModuleWrapper {
303303
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
304304
*
305305
* var out = dznrm2.main( x.length, x, 1 );
306-
* // returns ~9.53
306+
* // returns ~9.54
307307
*
308308
* @example
309309
* var Complex128Array = require( '@stdlib/array/complex128' );
@@ -312,7 +312,7 @@ interface Routine extends ModuleWrapper {
312312
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
313313
*
314314
* var out = dznrm2.ndarray( x.length, x, 1, 0 );
315-
* // returns ~9.53
315+
* // returns ~9.54
316316
*/
317317
declare var dznrm2: Routine;
318318

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ interface Routine extends ModuleWrapper {
218218
*
219219
* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
220220
*
221-
* var out = sasum.main( x.length, 5.0, x, 1, y, 1 );
221+
* var out = sasum.main( x.length, x, 1 );
222222
* // returns 15.0
223223
*/
224224
main( N: number, x: Float32Array, strideX: number ): number;

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ interface Routine extends ModuleWrapper {
219219
*
220220
* var x = new Complex64Array( [ 2.0, 1.0, 3.0, 5.0, 4.0, 0.0, 1.0, 3.0 ] );
221221
*
222-
* var out = scasum.main( x.length, 5.0, x, 1, y, 1 );
222+
* var out = scasum.main( x.length, x, 1 );
223223
* // returns 19.0
224224
*/
225225
main( N: number, x: Complex64Array, strideX: number ): number;
@@ -299,15 +299,15 @@ interface Routine extends ModuleWrapper {
299299
* var x = new Complex64Array( [ 2.0, 1.0, 3.0, 5.0, 4.0, 0.0, 1.0, 3.0 ] );
300300
*
301301
* var out = scasum.main( x.length, x, 1 );
302-
* // returns 21.0
302+
* // returns 19.0
303303
*
304304
* @example
305305
* var Complex64Array = require( '@stdlib/array/complex64' );
306306
*
307307
* var x = new Complex64Array( [ 2.0, 1.0, 3.0, 5.0, 4.0, 0.0, 1.0, 3.0 ] );
308308
*
309309
* var out = scasum.ndarray( x.length, x, 1, 0 );
310-
* // returns 21.0
310+
* // returns 19.0
311311
*/
312312
declare var scasum: Routine;
313313

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ interface Routine extends ModuleWrapper {
222222
*
223223
* // Perform operation:
224224
* var out = scnrm2.main( x.length, x, 1 );
225-
* // returns ~9.53
225+
* // returns ~9.54
226226
*/
227227
main( N: number, x: Complex64Array, strideX: number ): number;
228228

@@ -242,7 +242,7 @@ interface Routine extends ModuleWrapper {
242242
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
243243
*
244244
* var out = scnrm2.ndarray( x.length, x, 1, 0 );
245-
* // returns ~9.53
245+
* // returns ~9.54
246246
*/
247247
ndarray( N: number, x: Complex64Array, strideX: number, offsetX: number ): number;
248248

@@ -303,7 +303,7 @@ interface Routine extends ModuleWrapper {
303303
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
304304
*
305305
* var out = scnrm2.main( x.length, x, 1 );
306-
* // returns ~9.53
306+
* // returns ~9.54
307307
*
308308
* @example
309309
* var Complex64Array = require( '@stdlib/array/complex64' );
@@ -312,7 +312,7 @@ interface Routine extends ModuleWrapper {
312312
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
313313
*
314314
* var out = scnrm2.ndarray( x.length, x, 1, 0 );
315-
* // returns ~9.53
315+
* // returns ~9.54
316316
*/
317317
declare var scnrm2: Routine;
318318

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ interface ModuleConstructor {
7575
*
7676
* // Read out the results:
7777
* var viewX = zeros( N, dtype );
78-
* var viewY = zeros( n, dtype );
78+
* var viewY = zeros( N, dtype );
7979
* mod.read( xptr, viewX )
8080
* mod.read( yptr, viewY );
8181
* // viewX => <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -132,7 +132,7 @@ interface ModuleConstructor {
132132
*
133133
* // Read out the results:
134134
* var viewX = zeros( N, dtype );
135-
* var viewY = zeros( n, dtype );
135+
* var viewY = zeros( N, dtype );
136136
* mod.read( xptr, viewX )
137137
* mod.read( yptr, viewY );
138138
* // viewX => <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -198,7 +198,7 @@ interface Module extends ModuleWrapper {
198198
*
199199
* // Read out the results:
200200
* var viewX = zeros( N, dtype );
201-
* var viewY = zeros( n, dtype );
201+
* var viewY = zeros( N, dtype );
202202
* mod.read( xptr, viewX )
203203
* mod.read( yptr, viewY );
204204
* // viewX => <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -261,7 +261,7 @@ interface Module extends ModuleWrapper {
261261
*
262262
* // Read out the results:
263263
* var viewX = zeros( N, dtype );
264-
* var viewY = zeros( n, dtype );
264+
* var viewY = zeros( N, dtype );
265265
* mod.read( xptr, viewX )
266266
* mod.read( yptr, viewY );
267267
* // viewX => <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
@@ -369,7 +369,7 @@ interface Routine extends ModuleWrapper {
369369
*
370370
* // Read out the results:
371371
* var viewX = zeros( N, dtype );
372-
* var viewY = zeros( n, dtype );
372+
* var viewY = zeros( N, dtype );
373373
* mod.read( xptr, viewX )
374374
* mod.read( yptr, viewY );
375375
* // viewX => <Float32Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ interface Routine extends ModuleWrapper {
219219
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
220220
*
221221
* var out = dnanasumors.main( 4, x, 1 );
222-
* // returns 1.0
222+
* // returns 5.0
223223
*/
224224
main( N: number, x: Float64Array, strideX: number ): number;
225225

@@ -238,7 +238,7 @@ interface Routine extends ModuleWrapper {
238238
* var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
239239
*
240240
* var out = dnanasumors.ndarray( 4, x, 2, 1 );
241-
* // returns 5.0
241+
* // returns 9.0
242242
*/
243243
ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number;
244244

@@ -298,15 +298,15 @@ interface Routine extends ModuleWrapper {
298298
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
299299
*
300300
* var out = dnanasumors.main( 4, x, 1 );
301-
* // returns 1.0
301+
* // returns 5.0
302302
*
303303
* @example
304304
* var Float64Array = require( '@stdlib/array/float64' );
305305
*
306306
* var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
307307
*
308308
* var out = dnanasumors.ndarray( 4, x, 2, 1 );
309-
* // returns 5.0
309+
* // returns 9.0
310310
*/
311311
declare var dnanasumors: Routine;
312312

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ interface Routine extends ModuleWrapper {
216216
* @example
217217
* var Float64Array = require( '@stdlib/array/float64' );
218218
*
219-
* var x = new Float64Array( [ 1.0, -2.0, NaN 2.0 ] );
219+
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
220220
*
221221
* var out = dnansumpw.main( 4, x, 1 );
222222
* // returns 1.0

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@ interface Namespace {
5050
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
5151
*
5252
* ns.dapx.main( 3, 5.0, x, 1 );
53-
* // x => Float64Array[ 6.0, 3.0, 7.0 ]
53+
* // x => <Float64Array>[ 6.0, 3.0, 7.0 ]
5454
*
5555
* @example
5656
* var Float64Array = require( '@stdlib/array/float64' );
5757
*
5858
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
5959
*
6060
* ns.dapx.ndarray( 4, 5.0, x, 2, 1 );
61-
* // x => Float64Array[ 7.0, 6.0, 7.0, 3.0, 3.0, 7.0, 8.0, 9.0 ]
61+
* // x => <Float64Array>[ 2.0, 6.0, 2.0, 3.0, -2.0, 7.0, 3.0, 9.0 ]
6262
*/
6363
dapx: typeof dapx;
6464

@@ -210,15 +210,15 @@ interface Namespace {
210210
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
211211
*
212212
* var out = ns.dnanasumors.main( 4, x, 1 );
213-
* // returns 1.0
213+
* // returns 5.0
214214
*
215215
* @example
216216
* var Float64Array = require( '@stdlib/array/float64' );
217217
*
218218
* var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
219219
*
220220
* var out = ns.dnanasumors.ndarray( 4, x, 2, 1 );
221-
* // returns 5.0
221+
* // returns 9.0
222222
*/
223223
dnanasumors: typeof dnanasumors;
224224

0 commit comments

Comments
 (0)