Skip to content

Fix a typo in a type annotation #116

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 5 commits into from
Jan 21, 2021
Merged

Fix a typo in a type annotation #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc5b5d4
Fix some typos in some type annotations
asmeurer Jan 20, 2021
f11f7c0
Remove dtype from where() type annotation
asmeurer Jan 20, 2021
89fe85a
Fix type annotation for ord
asmeurer Jan 20, 2021
c522de4
Fix the type annotation for the axis argument to stack
asmeurer Jan 21, 2021
8f24f2b
Fix the type annotation for the endpoint argument to linspace
asmeurer Jan 21, 2021
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/creation_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Returns a new array having a specified `shape` and filled with `fill_value`.

- output array shape.

- **fill_value**: _Union\[ int, float ] ]_
- **fill_value**: _Union\[ int, float ]_

- fill value.

Expand Down Expand Up @@ -172,7 +172,7 @@ Returns a new array filled with `fill_value` and having the same `shape` as an i

- input array from which to derive the output array shape.

- **fill_value**: _Union\[ int, float ] ]_
- **fill_value**: _Union\[ int, float ]_

- fill value.

Expand Down Expand Up @@ -222,7 +222,7 @@ Returns evenly spaced numbers over a specified interval.

- device to place the created array on, if given. Default: `None`.

- **endpoint**: _Optional\[ bool ]_
- **endpoint**: _bool_

- boolean indicating whether to include `stop` in the interval. Default: `True`.

Expand Down
2 changes: 1 addition & 1 deletion spec/API_specification/linear_algebra_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Computes the matrix or vector norm of `x`.

- If `True`, the axes (dimensions) specified by `axis` must be included in the result as singleton dimensions, and, accordingly, the result must be compatible with the input array (see {ref}`broadcasting`). Otherwise, if `False`, the axes (dimensions) specified by `axis` must not be included in the result. Default: `False`.

- **ord**: _Optional\[ int, float, Literal\[ inf, -inf, 'fro', 'nuc' ] ]_
- **ord**: _Optional\[ Union\[ int, float, Literal\[ inf, -inf, 'fro', 'nuc' ] ] ]_

- order of the norm. The following mathematical norms must be supported:

Expand Down
2 changes: 1 addition & 1 deletion spec/API_specification/manipulation_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Joins a sequence of arrays along a new axis.

- input arrays to join. Each array must have the same shape.

- **axis**: _Optional\[ int ]_
- **axis**: _int_

- axis along which the arrays will be joined. Providing an `axis` specifies the index of the new axis in the dimensions of the result. For example, if `axis` is `0`, the new axis will be the first dimension and the output array will have shape `(N, A, B, C)`; if `axis` is `1`, the new axis will be the second dimension and the output array will have shape `(A, N, B, C)`; and, if `axis` is `-1`, the new axis will be the last dimension and the output array will have shape `(A, B, C, N)`. A valid `axis` must be on the interval `[-N, N)`, where `N` is the rank (number of dimensions) of `x`. If provided an `axis` outside of the required interval, the function must raise an exception. Default: `0`.

Expand Down
2 changes: 1 addition & 1 deletion spec/API_specification/searching_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Returns elements chosen from `x1` or `x2` depending on `condition`.

#### Parameters

- **condition**: _<array<bool>>_
- **condition**: _<array>_

- when `True`, yield `x1_i`; otherwise, yield `x2_i`. Must be compatible with `x1` and `x2` (see {ref}`broadcasting`).

Expand Down