docs: fix indexing kwarg typing in meshgrid

crusaderky · web-flow · commit 0941b216f623 · 2025-04-03T00:10:54.000-07:00
PR-URL: data-apis#915 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Lucas Colley
diff --git a/src/array_api_stubs/_2021_12/creation_functions.py b/src/array_api_stubs/_2021_12/creation_functions.py
@@ -1,5 +1,6 @@
 from ._types import (
     List,
+    Literal,
     NestedSequence,
     Optional,
     SupportsBufferProtocol,
@@ -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
diff --git a/src/array_api_stubs/_2022_12/creation_functions.py b/src/array_api_stubs/_2022_12/creation_functions.py
@@ -1,5 +1,6 @@
 from ._types import (
     List,
+    Literal,
     NestedSequence,
     Optional,
     SupportsBufferProtocol,
@@ -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
diff --git a/src/array_api_stubs/_2023_12/creation_functions.py b/src/array_api_stubs/_2023_12/creation_functions.py
@@ -20,6 +20,7 @@
 
 from ._types import (
     List,
+    Literal,
     NestedSequence,
     Optional,
     SupportsBufferProtocol,
@@ -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
diff --git a/src/array_api_stubs/_2024_12/creation_functions.py b/src/array_api_stubs/_2024_12/creation_functions.py
@@ -20,6 +20,7 @@
 
 from ._types import (
     List,
+    Literal,
     NestedSequence,
     Optional,
     SupportsBufferProtocol,
@@ -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
diff --git a/src/array_api_stubs/_draft/creation_functions.py b/src/array_api_stubs/_draft/creation_functions.py
@@ -20,6 +20,7 @@
 
 from ._types import (
     List,
+    Literal,
     NestedSequence,
     Optional,
     SupportsBufferProtocol,
@@ -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
