Skip to content

docs: update parameter name and description in ndarray/base TypeScript declaration #9660

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
Planeshifter merged 1 commit into from
Jan 10, 2026
Merged

docs: update parameter name and description in ndarray/base TypeScript declaration #9660

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1570,14 +1570,14 @@ interface Namespace {
everyBy: typeof everyBy;

/**
* Expands the shape of an array by inserting a new dimension of size one at a specified axis.
* Expands the shape of an array by inserting a new dimension of size one at a specified dimension index.
*
* ## Notes
*
* - A provided axis must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative `axis`, the axis position at which to insert a singleton dimension is computed as `N + axis + 1`. Hence, if provided `-1`, the resolved axis position is `N` (i.e., a singleton dimension is appended to the input array).
* - A provided dimension index must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative dimension index, the position at which to insert a singleton dimension is computed as `N + dim + 1`. Hence, if provided `-1`, the resolved position is `N` (i.e., a singleton dimension is appended to the input array).
*
* @param x - input array
* @param axis - axis at which to insert a singleton dimension
* @param dim - dimension index at which to insert a singleton dimension
* @param writable - boolean indicating whether the returned ndarray should be writable
* @returns output array
*
Expand Down