Skip to content

Commit baa67c1

Browse files
committed
docs: update comments
--- 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: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - 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 9d4a00b commit baa67c1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+72
-72
lines changed

lib/node_modules/@stdlib/ndarray/base/some/README.md

Lines changed: 2 additions & 2 deletions

lib/node_modules/@stdlib/ndarray/base/some/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{{alias}}( arrays )
33
Tests whether at least `n` elements in an ndarray are truthy.
44

5-
A provided "ndarray" should be an `object` with the following properties:
5+
A provided "ndarray" should be an object with the following properties:
66

77
- dtype: data type.
88
- data: data buffer.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
/// <reference types="@stdlib/types"/>
2222

23-
import { typedndarray } from '@stdlib/types/ndarray';
23+
import { ndarray, typedndarray, genericndarray } from '@stdlib/types/ndarray';
2424

2525
/**
2626
* Tests whether at least `n` elements in an ndarray are truthy.
@@ -32,7 +32,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
3232
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3333
* var Float64Array = require( '@stdlib/array/float64' );
3434
*
35-
* // Create data buffers:
35+
* // Create a data buffer:
3636
* 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 ] );
3737
*
3838
* // Define the shape of the array:
@@ -54,7 +54,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
5454
* var out = some( [ x, n ] );
5555
* // returns true
5656
*/
57-
declare function some<T = unknown>( arrays: [ typedndarray<T>, typedndarray<number>] ): boolean;
57+
declare function some( arrays: [ ndarray, typedndarray<number> | genericndarray<number> ] ): boolean;
5858

5959

6060
// EXPORTS //

lib/node_modules/@stdlib/ndarray/base/some/lib/0d.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
* // Define the index offset:
5151
* var ox = 1;
5252
*
53-
* // Create the input ndarray-like object:
53+
* // Create an input ndarray-like object:
5454
* var x = {
5555
* 'ref': null,
5656
* 'dtype': 'float64',

lib/node_modules/@stdlib/ndarray/base/some/lib/0d_accessors.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
* // Define the index offset:
5353
* var ox = 1;
5454
*
55-
* // Create the input ndarray-like object:
55+
* // Create an input ndarray-like object:
5656
* var x = {
5757
* 'ref': null,
5858
* 'dtype': 'generic',

lib/node_modules/@stdlib/ndarray/base/some/lib/0d_complex.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
* // Define the index offset:
5050
* var ox = 0;
5151
*
52-
* // Create the input ndarray-like object:
52+
* // Create an input ndarray-like object:
5353
* var x = {
5454
* 'dtype': 'complex128',
5555
* 'data': xbuf,

lib/node_modules/@stdlib/ndarray/base/some/lib/10d.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
5656
* // Define the index offset:
5757
* var ox = 1;
5858
*
59-
* // Create the input ndarray-like object:
59+
* // Create an input ndarray-like object:
6060
* var x = {
6161
* 'dtype': 'float64',
6262
* 'data': xbuf,

lib/node_modules/@stdlib/ndarray/base/some/lib/10d_accessors.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ var strides2order = require( '@stdlib/ndarray/base/strides2order' );
5858
* // Define the index offset:
5959
* var ox = 0;
6060
*
61-
* // Create the input ndarray-like object:
61+
* // Create an input ndarray-like object:
6262
* var x = {
6363
* 'dtype': 'generic',
6464
* 'data': xbuf,

lib/node_modules/@stdlib/ndarray/base/some/lib/10d_blocked.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
5757
* // Define the index offset:
5858
* var ox = 1;
5959
*
60-
* // Create the input ndarray-like object:
60+
* // Create an input ndarray-like object:
6161
* var x = {
6262
* 'dtype': 'float64',
6363
* 'data': xbuf,

lib/node_modules/@stdlib/ndarray/base/some/lib/10d_blocked_accessors.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
5959
* // Define the index offset:
6060
* var ox = 0;
6161
*
62-
* // Create the input ndarray-like object:
62+
* // Create an input ndarray-like object:
6363
* var x = {
6464
* 'dtype': 'generic',
6565
* 'data': xbuf,

0 commit comments

Comments
 (0)