summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorTravis Oliphant <oliphant@enthought.com>2006-09-28 12:58:14 +0000
committerTravis Oliphant <oliphant@enthought.com>2006-09-28 12:58:14 +0000
commitfeb91f47b9aec75fc94fd206090802bb665e6a5b (patch)
tree559f58a44bfeef94dbccc85cfce3b7ea9572beaa /numpy/add_newdocs.py
parent1b5e91c9fbac46e3c94fee936692e5558e7eef2f (diff)
downloadnumpy-feb91f47b9aec75fc94fd206090802bb665e6a5b.tar.gz
Update lexsort documentation a bit to give a hint as to how to use the keys to implement primary and secondary sorting
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index a9346c74f..482de23f1 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -363,8 +363,10 @@ add_newdoc('numpy.core.multiarray','lexsort',
key[0], then the resulting list of indices is further manipulated by
sorting on key[1], and so forth. The result is a sort on multiple
keys. If the keys represented columns of a spreadsheet, for example,
- this would sort using multiple columns. The keys argument must be a
- sequence of things that can be converted to arrays of the same shape.
+ this would sort using multiple columns (the last key being used for the
+ primary sort order, the second-to-last key for the secondary sort order,
+ and so on). The keys argument must be a sequence of things that can be
+ converted to arrays of the same shape.
""")