diff options
| author | Miki Watanabe <105326591+MikiPWata@users.noreply.github.com> | 2023-03-01 19:09:50 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-01 16:09:50 -0800 |
| commit | 6b0b97adc8b726ebc5e95643b21c175c0a71a7f4 (patch) | |
| tree | 015e2d2aff32ab76c0b50302ae19ae881768f5e7 /numpy/lib/function_base.py | |
| parent | 331c20da7ae57e7703723b5fc6eb44ea2a51b4e8 (diff) | |
| download | numpy-6b0b97adc8b726ebc5e95643b21c175c0a71a7f4.tar.gz | |
DOC: Fixed meshgrid docstring return type (#23310)
Meshgrid returns a list of ndarrays.
Co-authored-by: 渡邉 美希 <miki.watanabe@watanabenoMacBook-Pro.local>
Diffstat (limited to 'numpy/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index f5af314b5..405790025 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -4937,7 +4937,7 @@ def _meshgrid_dispatcher(*xi, copy=None, sparse=None, indexing=None): @array_function_dispatch(_meshgrid_dispatcher) def meshgrid(*xi, copy=True, sparse=False, indexing='xy'): """ - Return coordinate matrices from coordinate vectors. + Return a list of coordinate matrices from coordinate vectors. Make N-D coordinate arrays for vectorized evaluations of N-D scalar/vector fields over N-D grids, given @@ -4978,7 +4978,7 @@ def meshgrid(*xi, copy=True, sparse=False, indexing='xy'): Returns ------- - X1, X2,..., XN : ndarray + X1, X2,..., XN : list of ndarrays For vectors `x1`, `x2`,..., `xn` with lengths ``Ni=len(xi)``, returns ``(N1, N2, N3,..., Nn)`` shaped arrays if indexing='ij' or ``(N2, N1, N3,..., Nn)`` shaped arrays if indexing='xy' |