Skip to content

Commit da9d08b

Browse files
committed
docs: add missing require to TSDoc 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: na - task: lint_license_headers status: passed ---
1 parent 82be305 commit da9d08b

7 files changed

Lines changed: 9 additions & 1 deletion

File tree

lib/node_modules/@stdlib/ndarray/base/any-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 Predicate<T, U, ThisArg> = Nullary<ThisArg> | Unary<T, ThisArg> | Binary<T,
7777
*
7878
* @example
7979
* var Float64Array = require( '@stdlib/array/float64' );
80+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
8081
*
8182
* function predicate( value ) {
8283
* return value > 0.0;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import { ndarray } from '@stdlib/types/ndarray';
3131
*
3232
* @example
3333
* var Float64Array = require( '@stdlib/array/float64' );
34+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3435
*
3536
* // Create a data buffer:
3637
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

lib/node_modules/@stdlib/ndarray/base/count-if/docs/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
7777
*
7878
* @example
7979
* var Float64Array = require( '@stdlib/array/float64' );
80+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
8081
*
8182
* function predicate( value ) {
8283
* return value > 0.0;

lib/node_modules/@stdlib/ndarray/base/every-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 Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
7777
*
7878
* @example
7979
* var Float64Array = require( '@stdlib/array/float64' );
80+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
8081
*
8182
* function predicate( value ) {
8283
* return value > 0.0;

lib/node_modules/@stdlib/ndarray/base/for-each/docs/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,12 @@ type Callback<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
6666
*
6767
* @param arrays - array-like object containing an output ndarray
6868
* @param fcn - callback function
69+
* @param thisArg - callback function execution context
6970
*
7071
* @example
7172
* var Float64Array = require( '@stdlib/array/float64' );
7273
* var naryFunction = require( '@stdlib/utils/nary-function' );
74+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
7375
* var log = require( '@stdlib/console/log' );
7476
*
7577
* // Create data buffers:

lib/node_modules/@stdlib/ndarray/base/some-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 Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
7777
* @example
7878
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
7979
* var Float64Array = require( '@stdlib/array/float64' );
80+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
8081
*
8182
* function predicate( value ) {
8283
* return value > 0.0;

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ interface Vector {
581581
* // returns 2
582582
*
583583
* var dt = getDType( arr );
584-
* // returns 'float32'
584+
* // returns 'float64'
585585
*/
586586
<U extends keyof TypedDataTypeMap = 'float64'>( buffer: ArrayBuffer, byteOffset: number, options: Options ): TypedDataTypeMap[U];
587587

@@ -599,6 +599,7 @@ interface Vector {
599599
* @returns one-dimensional ndarray
600600
*
601601
* @example
602+
* var numel = require( '@stdlib/ndarray/numel' );
602603
* var ArrayBuffer = require( '@stdlib/array/buffer' );
603604
*
604605
* var buf = new ArrayBuffer( 32 );

0 commit comments

Comments
 (0)