Skip to content

Commit 7c9afed

Browse files
committed
chore: 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: 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 ed5e336 commit 7c9afed

File tree

22 files changed

+27
-26
lines changed

22 files changed

+27
-26
lines changed

lib/node_modules/@stdlib/array/base/bifurcate-entries-by/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
If a predicate function returns a truthy value, an array value is placed in
1212
the first group; otherwise, an array value is placed in the second group.
1313

14-
If provided an empty array, the function returns an empty object.
14+
If provided an empty array, the function returns an empty array.
1515

1616
Parameters
1717
----------
@@ -27,7 +27,7 @@
2727

2828
Returns
2929
-------
30-
out: Object
30+
out: Array
3131
Split results.
3232

3333
Examples

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ interface Where {
224224
* var out = [ 0, 0, 0, 0 ];
225225
* var condition = [ true, false, true, false ];
226226
*
227-
* var arr = assign( condition, x, y, out, 1, 0 );
227+
* var arr = where.assign( condition, x, y, out, 1, 0 );
228228
* // returns [ 1, 6, 3, 8 ]
229229
*
230230
* var bool = ( arr === out );

lib/node_modules/@stdlib/assert/has-tostringtag-support/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11

22
{{alias}}()
3-
Tests for native `toStringTag` support.
3+
Tests for native `Symbol.toStringTag` support.
44

55
Returns
66
-------
77
bool: boolean
8-
Boolean indicating if an environment has `toStringTag` support.
8+
Boolean indicating if an environment has `Symbol.toStringTag` support.
99

1010
Examples
1111
--------

lib/node_modules/@stdlib/assert/has-tostringtag-support/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Tests for native `toStringTag` support.
22+
* Tests for native `Symbol.toStringTag` support.
2323
*
24-
* @returns boolean indicating if an environment has `toStringTag` support
24+
* @returns boolean indicating if an environment has `Symbol.toStringTag` support
2525
*
2626
* @example
2727
* var bool = hasToStringTagSupport();

lib/node_modules/@stdlib/assert/has-tostringtag-support/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ var FLG = hasSymbols();
3131
// MAIN //
3232

3333
/**
34-
* Tests for native `toStringTag` support.
34+
* Tests for native `Symbol.toStringTag` support.
3535
*
36-
* @returns {boolean} boolean indicating if an environment has `toStringTag` support
36+
* @returns {boolean} boolean indicating if an environment has `Symbol.toStringTag` support
3737
*
3838
* @example
3939
* var bool = hasToStringTagSupport();

lib/node_modules/@stdlib/assert/has-weakmap-support/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* var hasWeakMapSupport = require( '@stdlib/assert/has-weakmap-support' );
2828
*
2929
* var bool = hasWeakMapSupport();
30-
* // returns <Boolean>
30+
* // returns <boolean>
3131
*/
3232

3333
// MODULES //

lib/node_modules/@stdlib/assert/has-weakset-support/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* var hasWeakSetSupport = require( '@stdlib/assert/has-weakset-support' );
2828
*
2929
* var bool = hasWeakSetSupport();
30-
* // returns <Boolean>
30+
* // returns <boolean>
3131
*/
3232

3333
// MODULES //

lib/node_modules/@stdlib/assert/is-array-like-object/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var MAX_LENGTH = require( '@stdlib/constants/array/max-array-length' );
3737
* // returns true
3838
*
3939
* @example
40-
* var bool = isArrayLikeObject( { 'length':10 } );
40+
* var bool = isArrayLikeObject( { 'length': 10 } );
4141
* // returns true
4242
*
4343
* @example

lib/node_modules/@stdlib/assert/is-array-like/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var MAX_LENGTH = require( '@stdlib/constants/array/max-array-length' );
3737
* // returns true
3838
*
3939
* @example
40-
* var bool = isArrayLike( {'length':10} );
40+
* var bool = isArrayLike( { 'length': 10 } );
4141
* // returns true
4242
*/
4343
function isArrayLike( value ) {

lib/node_modules/@stdlib/assert/is-arraybuffer-view/lib/main.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@ var ArrayBuffer = require( '@stdlib/array/buffer' );
2626
// MAIN //
2727

2828
/**
29-
* Determines whether an object is an array buffer view.
29+
* Tests if a value is an array buffer view.
3030
*
3131
* @param {*} value - value to test
3232
* @returns {boolean} boolean indicating whether value is an array buffer view
3333
*
3434
* @example
3535
* var Int8Array = require( '@stdlib/array/int8' );
36+
*
3637
* var bool = isArrayBufferView( new Int8Array( 10 ) );
3738
* // returns true
3839
*

lib/node_modules/@stdlib/assert/is-even/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Returns
1111
-------
1212
bool: boolean
13-
Boolean indicating whether is an even number.
13+
Boolean indicating whether value is an even number.
1414

1515
Examples
1616
--------

lib/node_modules/@stdlib/assert/tools/array-function/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
The returned function returns `false` if provided an empty array.
1414

15-
The returned function returns `false` is not provided an array.
15+
The returned function returns `false` if not provided an array.
1616

1717
Parameters
1818
----------

lib/node_modules/@stdlib/assert/tools/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: an array element. If the array element satisfies a test condition, the function should return `true`; otherwise, the function should return `false`.
3535
* - Given an input 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 array.
37-
* - The returned function returns `false` is not provided an array.
37+
* - The returned function returns `false` if not provided an array.
3838
*
3939
* @param predicate - function to apply
4040
* @returns an array function

lib/node_modules/@stdlib/assert/tools/array-like-function/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
The returned function returns `false` if provided an empty array-like
1414
object.
1515

16-
The returned function returns `false` is not provided an array-like object.
16+
The returned function returns `false` if not provided an array-like object.
1717

1818
Parameters
1919
----------

lib/node_modules/@stdlib/assert/tools/array-like-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: 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`.
3535
* - Given an input array-like object, the returned function returns `true` if all elements pass the test and `false` otherwise.
3636
* - The returned function returns `false` if provided an empty array-like object.
37-
* - The returned function returns `false` is not provided an array-like object.
37+
* - The returned function returns `false` if not provided an array-like object.
3838
*
3939
* @param predicate - function to apply
4040
* @returns an array-like object function

lib/node_modules/@stdlib/assert/tools/typed-array-function/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
The returned function returns `false` if provided an empty typed array.
1414

15-
The returned function returns `false` is not provided a typed array.
15+
The returned function returns `false` if not provided a typed array.
1616

1717
Parameters
1818
----------

lib/node_modules/@stdlib/blas/base/caxpy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Scales values from `X` by `alpha` and adds the result to `Y` using alternative i
240240
#include "stdlib/complex/float32/ctor.h"
241241

242242
float X[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
243-
float Y[] = { -1.0f, -2.0f, -3.0f, -4.0f, -5.0f, -6.0f, -7.0f, -8.0f }
243+
float Y[] = { -1.0f, -2.0f, -3.0f, -4.0f, -5.0f, -6.0f, -7.0f, -8.0f };
244244
const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f );
245245

246246
c_caxpy_ndarray( 4, alpha, (void *)X, 1, 0, (void *)Y, 1, 0 );

lib/node_modules/@stdlib/blas/base/cscal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Scales values from `X` by `alpha` using alternative indexing semantics.
225225
float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
226226
const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f );
227227

228-
c_cscal( 4, alpha, (void *)x, 1, 0 );
228+
c_cscal_ndarray( 4, alpha, (void *)x, 1, 0 );
229229
```
230230
231231
The function accepts the following arguments:

lib/node_modules/@stdlib/blas/base/daxpy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ The function accepts the following arguments:
232232
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
233233
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
234234
- **Y**: `[inout] double*` output array.
235-
- **strideY**: `[in CBLAS_INT` index increment for `Y`.
235+
- **strideY**: `[in] CBLAS_INT` index increment for `Y`.
236236
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
237237
238238
```c

lib/node_modules/@stdlib/blas/base/ddot/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ The function accepts the following arguments:
250250
- **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
251251
252252
```c
253-
double c_ddot_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY. const CBLAS_INT offsetY );
253+
double c_ddot_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
254254
```
255255

256256
</section>

lib/node_modules/@stdlib/blas/base/dnrm2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Computes the L2-norm of a double-precision floating-point vector using alternati
214214
```c
215215
const double x[] = { 1.0, -2.0, 2.0 };
216216

217-
double v = c_dnrm2( 3, x, -1, 2 );
217+
double v = c_dnrm2_ndarray( 3, x, -1, 2 );
218218
// returns 3.0
219219
```
220220

lib/node_modules/@stdlib/proxy/ctor/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
- setPrototypeOf( target, prototype )
1313
Trap for `Object.setPrototypeOf()`. The method must return a boolean
14-
indicating if prototype successfully set.
14+
indicating if the prototype was successfully set.
1515

1616
- isExtensible( target )
1717
Trap for `Object.isExtensible()`. The method must return a boolean.

0 commit comments

Comments
 (0)