Skip to content

Commit 3ca7c21

Browse files
authored
docs: propagate recent ndarray/base comment and note fixes to sibling packages
PR-URL: #11762 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 94fc2ce commit 3ca7c21

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

lib/node_modules/@stdlib/ndarray/base/empty-like/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ import emptyLike = require( './index' );
4343
emptyLike( zeros( 'generic', sh, ord ) ); // $ExpectType typedndarray<number>
4444
}
4545

46-
// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
46+
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
4747
{
4848
emptyLike( '10' ); // $ExpectError
4949
emptyLike( 10 ); // $ExpectError

lib/node_modules/@stdlib/ndarray/base/ones-like/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import onesLike = require( './index' );
4141
onesLike( ones( 'generic', sh, ord ) ); // $ExpectType genericndarray<number>
4242
}
4343

44-
// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
44+
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
4545
{
4646
onesLike( '10' ); // $ExpectError
4747
onesLike( 10 ); // $ExpectError

lib/node_modules/@stdlib/ndarray/base/rot90/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var format = require( '@stdlib/string/format' );
3939
* ## Notes
4040
*
4141
* - If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
42-
* - If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [1, 0]`, the function rotates the plane clockwise.
42+
* - If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane clockwise.
4343
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
4444
*
4545
* @param {ndarray} x - input array

lib/node_modules/@stdlib/ndarray/base/transpose/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import transpose = require( './index' );
4141
transpose( zeros( 'generic', sh, ord ), false ); // $ExpectType genericndarray<number>
4242
}
4343

44-
// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
44+
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
4545
{
4646
transpose( '10', false ); // $ExpectError
4747
transpose( 10, false ); // $ExpectError

lib/node_modules/@stdlib/ndarray/base/zeros-like/docs/types/test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import zerosLike = require( './index' );
4141
zerosLike( zeros( 'generic', sh, ord ) ); // $ExpectType genericndarray<number>
4242
}
4343

44-
// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
44+
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
4545
{
4646
zerosLike( '10' ); // $ExpectError
4747
zerosLike( 10 ); // $ExpectError

0 commit comments

Comments
 (0)