diff options
| author | lzkelley <lkelley@cfa.harvard.edu> | 2015-10-21 22:17:00 -0400 |
|---|---|---|
| committer | lzkelley <lkelley@cfa.harvard.edu> | 2015-10-21 22:17:00 -0400 |
| commit | f994f2a7569b35810e35c96897680f9b38f291f7 (patch) | |
| tree | a7cbff54e481c5a73f29c5bcaff34e25c233c70c /numpy/core/fromnumeric.py | |
| parent | bf28b4432183126c21f0fa80852c335e9c1ed7c1 (diff) | |
| download | numpy-f994f2a7569b35810e35c96897680f9b38f291f7.tar.gz | |
DOC: clarify usage of 'argparse' return value.
In response to Ticket #4724, explain that the 'index_array' returned by
'argparse' can only be used to (directly) sort a one-dimensional input
array.
Diffstat (limited to 'numpy/core/fromnumeric.py')
| -rw-r--r-- | numpy/core/fromnumeric.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 7ba364512..0fc572cb6 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -848,7 +848,7 @@ def argsort(a, axis=-1, kind='quicksort', order=None): ------- index_array : ndarray, int Array of indices that sort `a` along the specified axis. - In other words, ``a[index_array]`` yields a sorted `a`. + If `a` is one-dimensional, ``a[index_array]`` yields a sorted `a`. See Also -------- |