Skip to content

Commit ed5e336

Browse files
committed
docs: minor clean-up
--- 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: 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 bc3632a commit ed5e336

File tree

13 files changed

+20
-24
lines changed

13 files changed

+20
-24
lines changed

lib/node_modules/@stdlib/assert/is-negative-number-array/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ bool = isNegativeNumberArray( [ -3.0, '-3.0' ] );
4848

4949
#### isNegativeNumberArray.primitives( value )
5050

51-
Tests if a `value` is an array-like object `array` containing **only** primitive negative numbers.
51+
Tests if a `value` is an array-like object containing **only** primitive negative numbers.
5252

5353
<!-- eslint-disable no-new-wrappers -->
5454

@@ -64,7 +64,7 @@ bool = isNegativeNumberArray.primitives( [ -3.0, new Number(-1.0) ] );
6464

6565
#### isNegativeNumberArray.objects( value )
6666

67-
Tests if a `value` is an array-like object `array` containing **only** object negative numbers.
67+
Tests if a `value` is an array-like object containing **only** object negative numbers.
6868

6969
<!-- eslint-disable no-new-wrappers, max-len -->
7070

lib/node_modules/@stdlib/assert/is-negative-number/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ bool = isNegativeNumber.isObject( new Number( -3.0 ) );
101101

102102
```javascript
103103
var Number = require( '@stdlib/number/ctor' );
104-
105104
var isNegativeNumber = require( '@stdlib/assert/is-negative-number' );
106105

107106
var bool = isNegativeNumber( -5.0 );

lib/node_modules/@stdlib/assert/is-node-builtin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ Options:
113113

114114
```bash
115115
# Not escaped...
116-
$ echo -n $'crypto\nndarray' | is-note-builtin --split /\r?\n/
116+
$ echo -n $'crypto\nndarray' | is-node-builtin --split /\r?\n/
117117
# Escaped...
118-
$ echo -n $'crypto\nndarray' | is-note-builtin --split /\\r?\\n/
118+
$ echo -n $'crypto\nndarray' | is-node-builtin --split /\\r?\\n/
119119
```
120120

121121
- The implementation ignores trailing delimiters.

lib/node_modules/@stdlib/assert/is-nonnegative-integer-array/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ bool = isNonNegativeIntegerArray( [ 3.0, '3.0' ] );
4848

4949
#### isNonNegativeIntegerArray.primitives( value )
5050

51-
Tests if a `value` is an array-like object containing **only** nonnegative primitive `integer` values.
51+
Tests if a `value` is an array-like object containing **only** nonnegative primitive `integer` values.
5252

5353
<!-- eslint-disable no-new-wrappers -->
5454

@@ -64,7 +64,7 @@ bool = isNonNegativeIntegerArray.primitives( [ 3.0, new Number(1.0) ] );
6464

6565
#### isNonNegativeIntegerArray.objects( value )
6666

67-
Tests if a `value` is an array-like object containing **only** nonnegative object `integer` values.
67+
Tests if a `value` is an array-like object containing **only** nonnegative object `integer` values.
6868

6969
<!-- eslint-disable no-new-wrappers, max-len -->
7070

lib/node_modules/@stdlib/assert/is-nonnegative-number-array/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ bool = isNonNegativeNumberArray( [ 3.0, '3.0' ] );
4848

4949
#### isNonNegativeNumberArray.primitives( value )
5050

51-
Tests if a `value` is an array-like object `array` containing **only** primitive nonnegative numbers.
51+
Tests if a `value` is an array-like object containing **only** primitive nonnegative numbers.
5252

5353
<!-- eslint-disable no-new-wrappers -->
5454

@@ -64,7 +64,7 @@ bool = isNonNegativeNumberArray.primitives( [ 3.0, new Number(1.0) ] );
6464

6565
#### isNonNegativeNumberArray.objects( value )
6666

67-
Tests if a `value` is an array-like object `array` containing **only** object nonnegative numbers.
67+
Tests if a `value` is an array-like object containing **only** object nonnegative numbers.
6868

6969
<!-- eslint-disable no-new-wrappers, max-len -->
7070

lib/node_modules/@stdlib/assert/is-nonpositive-number-array/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ bool = isNonPositiveNumberArray( [ -3.0, '-3.0' ] );
4848

4949
#### isNonPositiveNumberArray.primitives( value )
5050

51-
Tests if a `value` is an array-like object `array` containing **only** primitive nonpositive numbers.
51+
Tests if a `value` is an array-like object containing **only** primitive nonpositive numbers.
5252

5353
<!-- eslint-disable no-new-wrappers -->
5454

@@ -64,7 +64,7 @@ bool = isNonPositiveNumberArray.primitives( [ -3.0, new Number(-1.0) ] );
6464

6565
#### isNonPositiveNumberArray.objects( value )
6666

67-
Tests if a `value` is an array-like object `array` containing **only** object nonpositive numbers.
67+
Tests if a `value` is an array-like object containing **only** object nonpositive numbers.
6868

6969
<!-- eslint-disable no-new-wrappers, max-len -->
7070

lib/node_modules/@stdlib/assert/is-positive-number-array/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ bool = isPositiveNumberArray( [ 3.0, '3.0' ] );
4848

4949
#### isPositiveNumberArray.primitives( value )
5050

51-
Tests if a `value` is an array-like object `array` containing **only** primitive positive numbers.
51+
Tests if a `value` is an array-like object containing **only** primitive positive numbers.
5252

5353
<!-- eslint-disable no-new-wrappers -->
5454

@@ -64,7 +64,7 @@ bool = isPositiveNumberArray.primitives( [ 3.0, new Number(1.0) ] );
6464

6565
#### isPositiveNumberArray.objects( value )
6666

67-
Tests if a `value` is an array-like object `array` containing **only** object positive numbers.
67+
Tests if a `value` is an array-like object containing **only** object positive numbers.
6868

6969
<!-- eslint-disable no-new-wrappers, max-len -->
7070

lib/node_modules/@stdlib/assert/is-probability-array/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ bool = isProbabilityArray( [ 3.14, 0.0 ] );
6363

6464
#### isProbabilityArray.primitives( value )
6565

66-
Tests if a `value` is an array-like object `array` containing **only** primitive probabilities.
66+
Tests if a `value` is an array-like object containing **only** primitive probabilities.
6767

6868
<!-- eslint-disable no-new-wrappers -->
6969

@@ -79,7 +79,7 @@ bool = isProbabilityArray.primitives( [ 0.9, new Number(1.0) ] );
7979

8080
#### isProbabilityArray.objects( value )
8181

82-
Tests if a `value` is an array-like object `array` containing **only** `Number` objects whose values are probabilities.
82+
Tests if a `value` is an array-like object containing **only** `Number` objects whose values are probabilities.
8383

8484
<!-- eslint-disable no-new-wrappers -->
8585

lib/node_modules/@stdlib/assert/is-ragged-nested-array/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var isRaggedNestedArray = require( '@stdlib/assert/is-ragged-nested-array' );
3232

3333
#### isRaggedNestedArray( value )
3434

35-
Tests if a value is a ragged nested array.
35+
Tests if a value is a ragged nested array.
3636

3737
```javascript
3838
var bool = isRaggedNestedArray( [ [ 1, 2, 3 ], [ 4, 5 ] ] );

lib/node_modules/@stdlib/assert/is-relative-uri/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ false
169169
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
170170

171171
```bash
172-
$ echo -n 'https://google.com\tbeep' | is-absolute-uri --split '\t'
172+
$ echo -n 'https://google.com\tbeep' | is-relative-uri --split '\t'
173173
false
174174
true
175175
```

lib/node_modules/@stdlib/assert/is-skew-symmetric-matrix/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ out = isSkewSymmetricMatrix( null );
8383
## See Also
8484

8585
- <span class="package-name">[`@stdlib/assert/is-matrix-like`][@stdlib/assert/is-matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object.</span>
86-
- <span class="package-name">[`@stdlib/assert/is-skew-symmetric-matrix`][@stdlib/assert/is-skew-symmetric-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a skew-symmetric matrix.</span>
8786
- <span class="package-name">[`@stdlib/assert/is-square-matrix`][@stdlib/assert/is-square-matrix]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object having equal dimensions.</span>
8887

8988
</section>
@@ -100,8 +99,6 @@ out = isSkewSymmetricMatrix( null );
10099

101100
[@stdlib/assert/is-matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-matrix-like
102101

103-
[@stdlib/assert/is-skew-symmetric-matrix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-skew-symmetric-matrix
104-
105102
[@stdlib/assert/is-square-matrix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-square-matrix
106103

107104
<!-- </related-links> -->

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ interface Namespace {
3636
* - The predicate function should accept a single argument: an array element. If the array element satisfies a test condition, the function should return `true`; otherwise, the function should return `false`.
3737
* - Given an input array, the returned function returns `true` if all elements pass the test and `false` otherwise.
3838
* - The returned function returns `false` if provided an empty array.
39-
* - The returned function returns `false` is not provided an array.
39+
* - The returned function returns `false` if not provided an array.
4040
*
4141
* @param predicate - function to apply
4242
* @returns an array function
@@ -65,7 +65,7 @@ interface Namespace {
6565
* - The predicate function should accept a single argument: an element from an array-like object. If the element satisfies a test condition, the function should return `true`; otherwise, the function should return `false`.
6666
* - Given an input array-like object, the returned function returns `true` if all elements pass the test and `false` otherwise.
6767
* - The returned function returns `false` if provided an empty array-like object.
68-
* - The returned function returns `false` is not provided an array-like object.
68+
* - The returned function returns `false` if not provided an array-like object.
6969
*
7070
* @param predicate - function to apply
7171
* @returns an array-like object function
@@ -94,7 +94,7 @@ interface Namespace {
9494
* - The predicate function should accept a single argument: a typed array element. If the element satisfies a test condition, the function should return `true`; otherwise, the function should return `false`.
9595
* - Given an input typed array, the returned function returns `true` if all elements pass the test and `false` otherwise.
9696
* - The returned function returns `false` if provided an empty typed array.
97-
* - The returned function returns `false` is not provided a typed array.
97+
* - The returned function returns `false` if not provided a typed array.
9898
*
9999
* @param predicate - function to apply
100100
* @returns a typed array function

lib/node_modules/@stdlib/assert/tools/typed-array-function/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ type PredicateFunction = ( elem: any ) => boolean;
3434
* - The predicate function should accept a single argument: a typed array element. If the element satisfies a test condition, the function should return `true`; otherwise, the function should return `false`.
3535
* - Given an input typed array, the returned function returns `true` if all elements pass the test and `false` otherwise.
3636
* - The returned function returns `false` if provided an empty typed array.
37-
* - The returned function returns `false` is not provided a typed array.
37+
* - The returned function returns `false` if not provided a typed array.
3838
*
3939
* @param predicate - function to apply
4040
* @returns a typed array function

0 commit comments

Comments
 (0)