summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorStefan van der Walt <stefan@sun.ac.za>2007-07-17 12:31:52 +0000
committerStefan van der Walt <stefan@sun.ac.za>2007-07-17 12:31:52 +0000
commita3e3548177a96b53e380b1c2070c0efb3c16da14 (patch)
treefd811ddaf20a5f6343818bba1633ed02a231c529 /numpy/add_newdocs.py
parent855587eec81895f0f1cf1be6b847c0e0af0fcce7 (diff)
downloadnumpy-a3e3548177a96b53e380b1c2070c0efb3c16da14.tar.gz
Fix documentation for 'where'.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 6efb99a8d..212915390 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -343,11 +343,11 @@ add_newdoc('numpy.core.multiarray','where',
The result is shaped like condition and has elements of x and y where
condition is respectively true or false. If x or y are not given,
- then it is equivalent to condition.nonzero().
+ condition.nonzero() is returned.
To group the indices by element, rather than dimension, use
- transpose(where(condition, | x, y))
+ transpose(where(condition))
instead. This always results in a 2d array, with a row of indices for
each element that satisfies the condition.