You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spec/API_specification/creation_functions.md
+18-2
Original file line number
Diff line number
Diff line change
@@ -290,7 +290,7 @@ Returns evenly spaced numbers over a specified interval.
290
290
- a one-dimensional array containing evenly spaced values.
291
291
292
292
(function-meshgrid)=
293
-
### meshgrid(*arrays, /, *, indexing='xy')
293
+
### meshgrid(*arrays, /, indexing='xy')
294
294
295
295
Returns coordinate matrices from coordinate vectors.
296
296
@@ -302,7 +302,7 @@ Returns coordinate matrices from coordinate vectors.
302
302
303
303
### Parameters
304
304
305
-
- ***arrays**: _<array>_
305
+
- **\*arrays**: _<array>_
306
306
307
307
- One dimensional arrays representing the coordinates of the grid.
308
308
@@ -316,6 +316,22 @@ Returns coordinate matrices from coordinate vectors.
316
316
317
317
- List of N arrays with rank `max(2, N)`.
318
318
319
+
### Notes
320
+
321
+
This function supports indexing conventions using the `indexing` keyword. In the case of `xy` the function will return a meshgrid with cartesian indexing, while `ij` will use matrix indexing. The difference is illustrated by the following code snippet:
0 commit comments