Skip to content

Make axis keyword to squeeze() positional #100

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
merged 1 commit into from
May 11, 2021
Merged

Make axis keyword to squeeze() positional #100

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 spec/API_specification/manipulation_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Rolls array elements along a specified axis. Array elements that roll beyond the
- an output array having the same data type as `x` and whose elements, relative to `x`, are shifted.

(function-squeeze)=
### squeeze(x, /, *, axis=None)
### squeeze(x, /, axis)

Removes singleton dimensions (axes) from `x`.

Expand All @@ -137,9 +137,9 @@ Removes singleton dimensions (axes) from `x`.

- input array.

- **axis**: _Optional\[ Union\[ int, Tuple\[ int, ... ] ] ]_
- **axis**: _Union\[ int, Tuple\[ int, ... ] ]_

- axis (or axes) to squeeze. If provided, only the specified axes must be squeezed. If `axis` is `None`, all singleton dimensions (axes) must be removed. If a specified axis has a size greater than one, the specified axis must be left unchanged. Default: `None`.
- axis (or axes) to squeeze. If a specified axis has a size greater than one, a `ValueError` must be raised.

#### Returns

Expand Down