Skip to content

docs: propagate recent ndarray/base comment and note fixes to sibling packages #11762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Apr 24, 2026
Merged

docs: propagate recent ndarray/base comment and note fixes to sibling packages #11762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c34822
docs: correct clockwise rotation note in `ndarray/base/rot90`
claude Apr 24, 2026
ba3c3eb
docs: fix comment across `ndarray/base/{empty-like,ones-like,zeros-li…
claude Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/base/empty-like/docs/types/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import emptyLike = require( './index' );
emptyLike( zeros( 'generic', sh, ord ) ); // $ExpectType typedndarray<number>
}

// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
{
emptyLike( '10' ); // $ExpectError
emptyLike( 10 ); // $ExpectError
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/base/ones-like/docs/types/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import onesLike = require( './index' );
onesLike( ones( 'generic', sh, ord ) ); // $ExpectType genericndarray<number>
}

// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
{
onesLike( '10' ); // $ExpectError
onesLike( 10 ); // $ExpectError
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/base/rot90/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var format = require( '@stdlib/string/format' );
* ## Notes
*
* - 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.
* - 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.
* - 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.
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
*
* @param {ndarray} x - input array
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/base/transpose/docs/types/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import transpose = require( './index' );
transpose( zeros( 'generic', sh, ord ), false ); // $ExpectType genericndarray<number>
}

// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
{
transpose( '10', false ); // $ExpectError
transpose( 10, false ); // $ExpectError
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/base/zeros-like/docs/types/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import zerosLike = require( './index' );
zerosLike( zeros( 'generic', sh, ord ) ); // $ExpectType genericndarray<number>
}

// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
// The compiler throws an error if the function is provided a first argument which is not an ndarray...
{
zerosLike( '10' ); // $ExpectError
zerosLike( 10 ); // $ExpectError
Expand Down
Loading