8000 DOC: clarify usage of 'argparse' return value. · jaimefrio/numpy@d032a6f · GitHub
[go: up one dir, main page]

Skip to content

Commit d032a6f

Browse files
lzkelleyjaimefrio
lzkelley
authored andcommitted
DOC: clarify usage of 'argparse' return value.
In response to Ticket numpy#4724, explain that the 'index_array' returned by 'argparse' can only be used to (directly) sort a one-dimensional input array.
1 parent 7e6959e commit d032a6f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

numpy/core/fromnumeric.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -848,7 +848,7 @@ def argsort(a, axis=-1, kind='quicksort', order=None):
848848
-------
849849
index_array : ndarray, int
850850
Array of indices that sort `a` along the specified axis.
851-
In other words, ``a[index_array]`` yields a sorted `a`.
851+
If `a` is one-dimensional, ``a[index_array]`` yields a sorted `a`.
852852
853853
See Also
854854
--------

0 commit comments

Comments
 (0)
0