Skip to content

Commit 546d714

Browse files
committed
docs: fix example code and return annotations in TSDoc declarations
--- 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 4d90d1a commit 546d714

File tree

6 files changed

+7
-13
lines changed

6 files changed

+7
-13
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ import { ArrayLike } from '@stdlib/types/array';
3131
* @example
3232
* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ];
3333
*
34-
* var shape = arrayShape( arr );
34+
* var sh = arrayShape( arr );
3535
* // returns [ 3, 3 ]
3636
*
3737
* @example
3838
* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ];
3939
*
40-
* var shape = arrayShape( arr );
40+
* var sh = arrayShape( arr );
4141
* // returns [ 3 ]
4242
*
4343
* @example
4444
* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], null ];
4545
*
46-
* var shape = arrayShape( arr );
46+
* var sh = arrayShape( arr );
4747
* // returns [ 3 ]
4848
*/
4949
declare function arrayShape( arr: ArrayLike<any> ): Array<number>;

lib/node_modules/@stdlib/boolean/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ interface Namespace {
5353
*
5454
* @example
5555
* var b = new ns.Boolean( false );
56-
* // returns <ns.Boolean>
56+
* // returns <Boolean>
5757
*/
5858
Boolean: typeof Boolean;
5959
}

lib/node_modules/@stdlib/buffer/docs/types/index.d.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ interface Namespace {
5959
* var ctor = require( '@stdlib/buffer/ctor' );
6060
*
6161
* var b = new ctor( [ 1, 2, 3, 4 ] );
62-
* // returns <ns.Buffer>
62+
* // returns <Buffer>
6363
*/
6464
Buffer: typeof Buffer;
6565

@@ -70,8 +70,6 @@ interface Namespace {
7070
* @returns new `Buffer` instance
7171
*
7272
* @example
73-
* var ns.array2buffer = require( '@stdlib/buffer/from-array' );
74-
*
7573
* var buf = ns.array2buffer( [ 1, 2, 3, 4 ] );
7674
* // returns <Buffer>
7775
*/

lib/node_modules/@stdlib/buffer/from-array/docs/types/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ import { Collection } from '@stdlib/types/array';
3131
* @returns new `Buffer` instance
3232
*
3333
* @example
34-
* var fromArray = require( '@stdlib/buffer/from-array' );
35-
*
3634
* var buf = fromArray( [ 1, 2, 3, 4 ] );
3735
* // returns <Buffer>
3836
*/

lib/node_modules/@stdlib/math/tools/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ interface Namespace {
3838
* @example
3939
* var base = require( '@stdlib/math/base/special/abs' );
4040
* var dispatch = require( '@stdlib/ndarray/dispatch' );
41-
* var unary = require( '@stdlib/ndarray/base/unary' );
41+
* var ndarrayUnary = require( '@stdlib/ndarray/base/unary' );
4242
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4343
* var array = require( '@stdlib/ndarray/array' );
4444
*
@@ -52,7 +52,7 @@ interface Namespace {
5252
* base,
5353
* base
5454
* ];
55-
* var dispatcher = dispatch( unary, types, data, 2, 1, 1 );
55+
* var dispatcher = dispatch( ndarrayUnary, types, data, 2, 1, 1 );
5656
*
5757
* var idt = [ 'float64', 'float32', 'generic' ];
5858
* var odt = idt;

lib/node_modules/@stdlib/utils/async/parallel/docs/types/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,6 @@ interface Parallel {
244244
* @param clbk - callback to invoke upon completion
245245
*
246246
* @example
247-
* var parallel = require( '@stdlib/utils/async/parallel' );
248-
*
249247
* function foo( clbk ) {
250248
* setTimeout( onTimeout, 300 );
251249
* function onTimeout() {

0 commit comments

Comments
 (0)