Skip to content

Commit 2ffc422

Browse files
committed
docs: fix TSDoc return annotation values and example code
--- 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 4dab954 commit 2ffc422

File tree

6 files changed

+27
-20
lines changed

6 files changed

+27
-20
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ import { ndarray } from '@stdlib/types/ndarray';
5454
* // returns [ 3, 2, 2 ]
5555
*
5656
* var out = broadcastArrays( [ x1, y1 ] );
57-
* // returns <ndarray>
57+
* // returns [ <ndarray>, <ndarray> ]
5858
*
5959
* var x2 = out[ 0 ];
6060
* // returns <ndarray>

lib/node_modules/@stdlib/ndarray/base/transpose/docs/types/index.d.ts

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ import { ndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, in
3232
* var array = require( '@stdlib/ndarray/array' );
3333
*
3434
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
35-
* 'dtype': 'float64'
35+
* 'dtype': 'float64',
36+
* 'casting': 'unsafe'
3637
* });
3738
* // returns <ndarray>
3839
*
@@ -63,7 +64,8 @@ declare function transpose( x: float64ndarray ): float64ndarray;
6364
* var array = require( '@stdlib/ndarray/array' );
6465
*
6566
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
66-
* 'dtype': 'float32'
67+
* 'dtype': 'float32',
68+
* 'casting': 'unsafe'
6769
* });
6870
* // returns <ndarray>
6971
*
@@ -150,7 +152,8 @@ declare function transpose( x: complex64ndarray ): complex64ndarray;
150152
* var array = require( '@stdlib/ndarray/array' );
151153
*
152154
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
153-
* 'dtype': 'int32'
155+
* 'dtype': 'int32',
156+
* 'casting': 'unsafe'
154157
* });
155158
* // returns <ndarray>
156159
*
@@ -181,8 +184,9 @@ declare function transpose( x: int32ndarray ): int32ndarray;
181184
* var array = require( '@stdlib/ndarray/array' );
182185
*
183186
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
184-
* 'dtype': 'int16'
185-
* });
187+
* 'dtype': 'int16',
188+
* 'casting': 'unsafe'
189+
* });
186190
* // returns <ndarray>
187191
*
188192
* var sh = x.shape;
@@ -212,7 +216,8 @@ declare function transpose( x: int16ndarray ): int16ndarray;
212216
* var array = require( '@stdlib/ndarray/array' );
213217
*
214218
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
215-
* 'dtype': 'int8'
219+
* 'dtype': 'int8',
220+
* 'casting': 'unsafe'
216221
* });
217222
* // returns <ndarray>
218223
*
@@ -243,7 +248,8 @@ declare function transpose( x: int8ndarray ): int8ndarray;
243248
* var array = require( '@stdlib/ndarray/array' );
244249
*
245250
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
246-
* 'dtype': 'uint32'
251+
* 'dtype': 'uint32',
252+
* 'casting': 'unsafe'
247253
* });
248254
* // returns <ndarray>
249255
*
@@ -274,7 +280,8 @@ declare function transpose( x: uint32ndarray ): uint32ndarray;
274280
* var array = require( '@stdlib/ndarray/array' );
275281
*
276282
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
277-
* 'dtype': 'uint16'
283+
* 'dtype': 'uint16',
284+
* 'casting': 'unsafe'
278285
* });
279286
* // returns <ndarray>
280287
*
@@ -305,7 +312,8 @@ declare function transpose( x: uint16ndarray ): uint16ndarray;
305312
* var array = require( '@stdlib/ndarray/array' );
306313
*
307314
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
308-
* 'dtype': 'uint8'
315+
* 'dtype': 'uint8',
316+
* 'casting': 'unsafe'
309317
* });
310318
* // returns <ndarray>
311319
*
@@ -336,7 +344,8 @@ declare function transpose( x: uint8ndarray ): uint8ndarray;
336344
* var array = require( '@stdlib/ndarray/array' );
337345
*
338346
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
339-
* 'dtype': 'uint8c'
347+
* 'dtype': 'uint8c',
348+
* 'casting': 'unsafe'
340349
* });
341350
* // returns <ndarray>
342351
*

lib/node_modules/@stdlib/ndarray/from-scalar/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ declare function scalar2ndarray( value: boolean, options: BoolOptions ): boolnda
330330
* @example
331331
* var x = scalar2ndarray( 1, {
332332
* 'dtype': 'int32'
333-
* };
333+
* });
334334
* // returns <ndarray>
335335
*
336336
* var sh = x.shape;
@@ -353,8 +353,8 @@ declare function scalar2ndarray( value: number, options: Int32Options ): int32nd
353353
*
354354
* @example
355355
* var x = scalar2ndarray( 1, {
356-
* 'dtype': int16'
357-
* };
356+
* 'dtype': 'int16'
357+
* });
358358
* // returns <ndarray>
359359
*
360360
* var sh = x.shape;
@@ -450,7 +450,7 @@ declare function scalar2ndarray( value: number, options: Uint16Options ): uint16
450450
* @example
451451
* var x = scalar2ndarray( 1, {
452452
* 'dtype': 'uint8'
453-
* };
453+
* });
454454
* // returns <ndarray>
455455
*
456456
* var sh = x.shape;
@@ -473,7 +473,7 @@ declare function scalar2ndarray( value: number, options: Uint8Options ): uint8nd
473473
*
474474
* @example
475475
* var x = scalar2ndarray( 1, {
476-
* 'dtype': uint8c'
476+
* 'dtype': 'uint8c'
477477
* });
478478
* // returns <ndarray>
479479
*

lib/node_modules/@stdlib/ndarray/slice-assign/docs/types/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,6 @@ declare function sliceAssign<T = unknown, U = unknown>( x: typedndarray<T>, y: g
328328
* var s0 = null;
329329
* var s1 = new Slice( null, null, -1 );
330330
* var s2 = new Slice( null, null, -1 );
331-
* // returns <MultiSlice>
332331
*
333332
* // Perform assignment:
334333
* var out = sliceAssign( x, y, [ s0, s1, s2 ] );
@@ -386,7 +385,6 @@ declare function sliceAssign<T = unknown, U = unknown>( x: typedndarray<T>, y: g
386385
* var s0 = null;
387386
* var s1 = new Slice( null, null, -1 );
388387
* var s2 = new Slice( null, null, -1 );
389-
* // returns <MultiSlice>
390388
*
391389
* // Perform assignment:
392390
* var out = sliceAssign( x, y, s0, s1, s2 );

lib/node_modules/@stdlib/ndarray/slice-assign/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ import sliceAssign = require( './index' );
115115
sliceAssign( null, y, s ); // $ExpectError
116116
sliceAssign( [], y, s ); // $ExpectError
117117
sliceAssign( {}, y, s ); // $ExpectError
118-
sliceAssign( ( x: number ): number => y, y, s ); // $ExpectError
118+
sliceAssign( (): number => y, y, s ); // $ExpectError
119119

120120
sliceAssign( '10', y, s, {} ); // $ExpectError
121121
sliceAssign( 10, y, s, {} ); // $ExpectError

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ interface Vector {
578578
* // returns <ndarray>
579579
*
580580
* var len = numel( arr );
581-
* // returns 2
581+
* // returns 1
582582
*
583583
* var dt = getDType( arr );
584584
* // returns 'float64'

0 commit comments

Comments
 (0)