Skip to content

Commit 7f55434

Browse files
PlaneshifterPlaneshifter
committed
docs: fix TSDoc comments example code and return annotation values
--- 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 47088cc commit 7f55434

File tree

6 files changed

+34
-35
lines changed

6 files changed

+34
-35
lines changed

‎lib/node_modules/@stdlib/array/docs/types/index.d.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -357,21 +357,21 @@ interface Namespace {
357357
*
358358
* @example
359359
* var arr = new ns.Complex128Array();
360-
* // returns <ns.Complex128Array>
360+
* // returns <Complex128Array>
361361
*
362362
* var len = arr.length;
363363
* // returns 0
364364
*
365365
* @example
366366
* var arr = new ns.Complex128Array( 2 );
367-
* // returns <ns.Complex128Array>
367+
* // returns <Complex128Array>
368368
*
369369
* var len = arr.length;
370370
* // returns 2
371371
*
372372
* @example
373373
* var arr = new ns.Complex128Array( [ 1.0, -1.0 ] );
374-
* // returns <ns.Complex128Array>
374+
* // returns <Complex128Array>
375375
*
376376
* var len = arr.length;
377377
* // returns 1
@@ -381,27 +381,27 @@ interface Namespace {
381381
*
382382
* var buf = new ArrayBuffer( 16 );
383383
* var arr = new ns.Complex128Array( buf );
384-
* // returns <ns.Complex128Array>
384+
* // returns <Complex128Array>
385385
*
386386
* var len = arr.length;
387-
* // returns 2
387+
* // returns 1
388388
*
389389
* @example
390390
* var ArrayBuffer = require( '@stdlib/array/buffer' );
391391
*
392-
* var buf = new ArrayBuffer( 16 );
393-
* var arr = new ns.Complex128Array( buf, 8 );
394-
* // returns <ns.Complex128Array>
392+
* var buf = new ArrayBuffer( 32 );
393+
* var arr = new ns.Complex128Array( buf, 16 );
394+
* // returns <Complex128Array>
395395
*
396396
* var len = arr.length;
397397
* // returns 1
398398
*
399399
* @example
400400
* var ArrayBuffer = require( '@stdlib/array/buffer' );
401401
*
402-
* var buf = new ArrayBuffer( 32 );
403-
* var arr = new ns.Complex128Array( buf, 8, 2 );
404-
* // returns <ns.Complex128Array>
402+
* var buf = new ArrayBuffer( 48 );
403+
* var arr = new ns.Complex128Array( buf, 16, 2 );
404+
* // returns <Complex128Array>
405405
*
406406
* var len = arr.length;
407407
* // returns 2
@@ -668,7 +668,7 @@ interface Namespace {
668668
*
669669
* var out = new Float64Array( 10 );
670670
* var arr = ns.iterator2array( iter, out, scale );
671-
* // returns <Array>
671+
* // returns <Float64Array>
672672
*/
673673
iterator2array: typeof iterator2array;
674674

@@ -1287,19 +1287,19 @@ interface Namespace {
12871287
* @example
12881288
* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ];
12891289
*
1290-
* var ns.shape = ns.shape( arr );
1290+
* var sh = ns.shape( arr );
12911291
* // returns [ 3, 3 ]
12921292
*
12931293
* @example
12941294
* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ];
12951295
*
1296-
* var ns.shape = ns.shape( arr );
1296+
* var sh = ns.shape( arr );
12971297
* // returns [ 3 ]
12981298
*
12991299
* @example
13001300
* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], null ];
13011301
*
1302-
* var ns.shape = ns.shape( arr );
1302+
* var sh = ns.shape( arr );
13031303
* // returns [ 3 ]
13041304
*/
13051305
shape: typeof shape;

‎lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-arrays/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ import { ndarray } from '@stdlib/types/ndarray';
5353
* var shy = y1.shape;
5454
* // returns [ 3, 2, 2 ]
5555
*
56-
* var out = maybeBroadcastArrays( [ x, y ] );
57-
* // returns <ndarray>
56+
* var out = maybeBroadcastArrays( [ x, y1 ] );
57+
* // returns [ <ndarray>, <ndarray> ]
5858
*
5959
* var x2 = out[ 0 ];
6060
* // returns <ndarray>

‎lib/node_modules/@stdlib/ndarray/maybe-broadcast-arrays/docs/types/index.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ import { typedndarray } from '@stdlib/types/ndarray';
5252
* var shy = y1.shape;
5353
* // returns [ 3, 2, 2 ]
5454
*
55-
* var out = maybeBroadcastArrays( [ x, y ] );
56-
* // returns <ndarray>
55+
* var out = maybeBroadcastArrays( [ x, y1 ] );
56+
* // returns [ <ndarray>, <ndarray> ]
5757
*
5858
* var x2 = out[ 0 ];
5959
* // returns <ndarray>
@@ -116,8 +116,8 @@ declare function maybeBroadcastArrays<T = unknown>( arrays: ArrayLike<typedndarr
116116
* var shy = y1.shape;
117117
* // returns [ 3, 2, 2 ]
118118
*
119-
* var out = maybeBroadcastArrays( x, y );
120-
* // returns <ndarray>
119+
* var out = maybeBroadcastArrays( x, y1 );
120+
* // returns [ <ndarray>, <ndarray> ]
121121
*
122122
* var x2 = out[ 0 ];
123123
* // returns <ndarray>

‎lib/node_modules/@stdlib/stats/strided/wasm/dnanvariancewd/docs/types/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ interface Routine extends ModuleWrapper {
242242
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
243243
*
244244
* var out = dnanvariancewd.ndarray( 5, 1, x, 2, 1 );
245-
* // returns ~4.7857
245+
* // returns 6.25
246246
*/
247247
ndarray( N: number, correction: number, x: Float64Array, strideX: number, offsetX: number ): number;
248248

‎lib/node_modules/@stdlib/stats/strided/wasm/dnanvariancewd/docs/types/test.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,6 @@ import dnanvariancewd = require( './index' );
125125
{
126126
const x = new Float64Array( 10 );
127127

128-
dnanvariancewd.ndarray( x.length, 10, x, 1, 0 ); // $ExpectError
129128
dnanvariancewd.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError
130129
dnanvariancewd.ndarray( x.length, true, x, 1, 0 ); // $ExpectError
131130
dnanvariancewd.ndarray( x.length, false, x, 1, 0 ); // $ExpectError

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ interface GetSetAccessorObject<T> extends OutputObject {
754754
* var fcns = obj.accessors;
755755
* // returns [ <Function>, <Function> ]
756756
*
757-
* var v = fcns[ 0 ]( x.data, 2 );
757+
* var v = fcns[ 0 ]( x, 2 );
758758
* // returns 3
759759
*/
760760
declare function strided2object( N: number, x: Float64Array, stride: number, offset: number ): Float64AccessorObject;
@@ -796,7 +796,7 @@ declare function strided2object( N: number, x: Float64Array, stride: number, off
796796
* var fcns = obj.accessors;
797797
* // returns [ <Function>, <Function> ]
798798
*
799-
* var v = fcns[ 0 ]( x.data, 2 );
799+
* var v = fcns[ 0 ]( x, 2 );
800800
* // returns 3
801801
*/
802802
declare function strided2object( N: number, x: Float32Array, stride: number, offset: number ): Float32AccessorObject;
@@ -838,7 +838,7 @@ declare function strided2object( N: number, x: Float32Array, stride: number, off
838838
* var fcns = obj.accessors;
839839
* // returns [ <Function>, <Function> ]
840840
*
841-
* var v = fcns[ 0 ]( x.data, 2 );
841+
* var v = fcns[ 0 ]( x, 2 );
842842
* // returns 3
843843
*/
844844
declare function strided2object( N: number, x: Int32Array, stride: number, offset: number ): Int32AccessorObject;
@@ -880,7 +880,7 @@ declare function strided2object( N: number, x: Int32Array, stride: number, offse
880880
* var fcns = obj.accessors;
881881
* // returns [ <Function>, <Function> ]
882882
*
883-
* var v = fcns[ 0 ]( x.data, 2 );
883+
* var v = fcns[ 0 ]( x, 2 );
884884
* // returns 3
885885
*/
886886
declare function strided2object( N: number, x: Int16Array, stride: number, offset: number ): Int16AccessorObject;
@@ -922,7 +922,7 @@ declare function strided2object( N: number, x: Int16Array, stride: number, offse
922922
* var fcns = obj.accessors;
923923
* // returns [ <Function>, <Function> ]
924924
*
925-
* var v = fcns[ 0 ]( x.data, 2 );
925+
* var v = fcns[ 0 ]( x, 2 );
926926
* // returns 3
927927
*/
928928
declare function strided2object( N: number, x: Int8Array, stride: number, offset: number ): Int8AccessorObject;
@@ -964,7 +964,7 @@ declare function strided2object( N: number, x: Int8Array, stride: number, offset
964964
* var fcns = obj.accessors;
965965
* // returns [ <Function>, <Function> ]
966966
*
967-
* var v = fcns[ 0 ]( x.data, 2 );
967+
* var v = fcns[ 0 ]( x, 2 );
968968
* // returns 3
969969
*/
970970
declare function strided2object( N: number, x: Uint32Array, stride: number, offset: number ): Uint32AccessorObject;
@@ -1006,7 +1006,7 @@ declare function strided2object( N: number, x: Uint32Array, stride: number, offs
10061006
* var fcns = obj.accessors;
10071007
* // returns [ <Function>, <Function> ]
10081008
*
1009-
* var v = fcns[ 0 ]( x.data, 2 );
1009+
* var v = fcns[ 0 ]( x, 2 );
10101010
* // returns 3
10111011
*/
10121012
declare function strided2object( N: number, x: Uint16Array, stride: number, offset: number ): Uint16AccessorObject;
@@ -1048,7 +1048,7 @@ declare function strided2object( N: number, x: Uint16Array, stride: number, offs
10481048
* var fcns = obj.accessors;
10491049
* // returns [ <Function>, <Function> ]
10501050
*
1051-
* var v = fcns[ 0 ]( x.data, 2 );
1051+
* var v = fcns[ 0 ]( x, 2 );
10521052
* // returns 3
10531053
*/
10541054
declare function strided2object( N: number, x: Uint8Array, stride: number, offset: number ): Uint8AccessorObject;
@@ -1090,7 +1090,7 @@ declare function strided2object( N: number, x: Uint8Array, stride: number, offse
10901090
* var fcns = obj.accessors;
10911091
* // returns [ <Function>, <Function> ]
10921092
*
1093-
* var v = fcns[ 0 ]( x.data, 2 );
1093+
* var v = fcns[ 0 ]( x, 2 );
10941094
* // returns 3
10951095
*/
10961096
declare function strided2object( N: number, x: Uint8ClampedArray, stride: number, offset: number ): Uint8cAccessorObject;
@@ -1226,7 +1226,7 @@ declare function strided2object( N: number, x: Complex64Array, stride: number, o
12261226
* var fcns = obj.accessors;
12271227
* // returns [ <Function>, <Function> ]
12281228
*
1229-
* var v = fcns[ 0 ]( x.data, 2 );
1229+
* var v = fcns[ 0 ]( x, 2 );
12301230
* // returns 3
12311231
*/
12321232
declare function strided2object<T = unknown>( N: number, x: AccessorArrayLike<T>, stride: number, offset: number ): GetSetAccessorObject<T>;
@@ -1266,7 +1266,7 @@ declare function strided2object<T = unknown>( N: number, x: AccessorArrayLike<T>
12661266
* var fcns = obj.accessors;
12671267
* // returns [ <Function>, <Function> ]
12681268
*
1269-
* var v = fcns[ 0 ]( x.data, 2 );
1269+
* var v = fcns[ 0 ]( x, 2 );
12701270
* // returns 3
12711271
*/
12721272
declare function strided2object<T = unknown>( N: number, x: Array<T>, stride: number, offset: number ): GenericAccessorObject<T>;
@@ -1312,7 +1312,7 @@ declare function strided2object<T = unknown>( N: number, x: Array<T>, stride: nu
13121312
* var fcns = obj.accessors;
13131313
* // returns [ <Function>, <Function> ]
13141314
*
1315-
* var v = fcns[ 0 ]( x.data, 2 );
1315+
* var v = fcns[ 0 ]( x, 2 );
13161316
* // returns 3
13171317
*/
13181318
declare function strided2object<T = unknown>( N: number, x: Collection<T>, stride: number, offset: number ): IndexedAccessorObject<T>;

0 commit comments

Comments
 (0)