Skip to content

docs: fix indexing kwarg typing in meshgrid #915

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 2 commits into from
Apr 3, 2025
Merged

docs: fix indexing kwarg typing in meshgrid #915

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
6211129
meshgrid xy parameter should be literal
crusaderky Mar 21, 2025
a034f46
backport
crusaderky Mar 26, 2025
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
5 changes: 3 additions & 2 deletions src/array_api_stubs/_2021_12/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from ._types import (
List,
Literal,
NestedSequence,
Optional,
SupportsBufferProtocol,
Expand Down Expand Up @@ -311,15 +312,15 @@ def linspace(
"""


def meshgrid(*arrays: array, indexing: str = "xy") -> List[array]:
def meshgrid(*arrays: array, indexing: Literal["xy", "ij"] = "xy") -> List[array]:
"""
Returns coordinate matrices from coordinate vectors.

Parameters
----------
arrays: array
an arbitrary number of one-dimensional arrays representing grid coordinates. Each array should have the same numeric data type.
indexing: str
indexing: Literal["xy", "ij"]
Cartesian ``'xy'`` or matrix ``'ij'`` indexing of output. If provided zero or one one-dimensional vector(s) (i.e., the zero- and one-dimensional cases, respectively), the ``indexing`` keyword has no effect and should be ignored. Default: ``'xy'``.

Returns
Expand Down
5 changes: 3 additions & 2 deletions src/array_api_stubs/_2022_12/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from ._types import (
List,
Literal,
NestedSequence,
Optional,
SupportsBufferProtocol,
Expand Down Expand Up @@ -372,15 +373,15 @@ def linspace(
"""


def meshgrid(*arrays: array, indexing: str = "xy") -> List[array]:
def meshgrid(*arrays: array, indexing: Literal["xy", "ij"] = "xy") -> List[array]:
"""
Returns coordinate matrices from coordinate vectors.

Parameters
----------
arrays: array
an arbitrary number of one-dimensional arrays representing grid coordinates. Each array should have the same numeric data type.
indexing: str
indexing: Literal["xy", "ij"]
Cartesian ``'xy'`` or matrix ``'ij'`` indexing of output. If provided zero or one one-dimensional vector(s) (i.e., the zero- and one-dimensional cases, respectively), the ``indexing`` keyword has no effect and should be ignored. Default: ``'xy'``.

Returns
Expand Down
5 changes: 3 additions & 2 deletions src/array_api_stubs/_2023_12/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

from ._types import (
List,
Literal,
NestedSequence,
Optional,
SupportsBufferProtocol,
Expand Down Expand Up @@ -454,15 +455,15 @@ def linspace(
"""


def meshgrid(*arrays: array, indexing: str = "xy") -> List[array]:
def meshgrid(*arrays: array, indexing: Literal["xy", "ij"] = "xy") -> List[array]:
"""
Returns coordinate matrices from coordinate vectors.

Parameters
----------
arrays: array
an arbitrary number of one-dimensional arrays representing grid coordinates. Each array should have the same numeric data type.
indexing: str
indexing: Literal["xy", "ij"]
Cartesian ``'xy'`` or matrix ``'ij'`` indexing of output. If provided zero or one one-dimensional vector(s) (i.e., the zero- and one-dimensional cases, respectively), the ``indexing`` keyword has no effect and should be ignored. Default: ``'xy'``.

Returns
Expand Down
5 changes: 3 additions & 2 deletions src/array_api_stubs/_2024_12/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

from ._types import (
List,
Literal,
NestedSequence,
Optional,
SupportsBufferProtocol,
Expand Down Expand Up @@ -454,15 +455,15 @@ def linspace(
"""


def meshgrid(*arrays: array, indexing: str = "xy") -> List[array]:
def meshgrid(*arrays: array, indexing: Literal["xy", "ij"] = "xy") -> List[array]:
"""
Returns coordinate matrices from coordinate vectors.

Parameters
----------
arrays: array
an arbitrary number of one-dimensional arrays representing grid coordinates. Each array should have the same numeric data type.
indexing: str
indexing: Literal["xy", "ij"]
Cartesian ``'xy'`` or matrix ``'ij'`` indexing of output. If provided zero or one one-dimensional vector(s) (i.e., the zero- and one-dimensional cases, respectively), the ``indexing`` keyword has no effect and should be ignored. Default: ``'xy'``.

Returns
Expand Down
5 changes: 3 additions & 2 deletions src/array_api_stubs/_draft/creation_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

from ._types import (
List,
Literal,
NestedSequence,
Optional,
SupportsBufferProtocol,
Expand Down Expand Up @@ -454,15 +455,15 @@ def linspace(
"""


def meshgrid(*arrays: array, indexing: str = "xy") -> List[array]:
def meshgrid(*arrays: array, indexing: Literal["xy", "ij"] = "xy") -> List[array]:
"""
Returns coordinate matrices from coordinate vectors.

Parameters
----------
arrays: array
an arbitrary number of one-dimensional arrays representing grid coordinates. Each array should have the same numeric data type.
indexing: str
indexing: Literal["xy", "ij"]
Cartesian ``'xy'`` or matrix ``'ij'`` indexing of output. If provided zero or one one-dimensional vector(s) (i.e., the zero- and one-dimensional cases, respectively), the ``indexing`` keyword has no effect and should be ignored. Default: ``'xy'``.

Returns
Expand Down