summaryrefslogtreecommitdiff
path: root/numpy/lib
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2014-02-16 13:29:45 -0700
committerCharles Harris <charlesr.harris@gmail.com>2014-02-16 15:29:44 -0700
commitd1dc51bea3c46b99e4f4fb38b7b31f66c93dc18b (patch)
tree30ec3bc1fdbd9171b6ba0cf7114c9734a4efadaf /numpy/lib
parent2868dc4a0513f58eafc013f3ba3d84ae07113199 (diff)
downloadnumpy-d1dc51bea3c46b99e4f4fb38b7b31f66c93dc18b.tar.gz
DOC: Document that fliplr only works on 2-D arrays.
Docstring claimed 2-D was not required, but it is. Fix that. Closes #3332.
Diffstat (limited to 'numpy/lib')
-rw-r--r--numpy/lib/twodim_base.py5
1 files changed, 2 insertions, 3 deletions
diff --git a/numpy/lib/twodim_base.py b/numpy/lib/twodim_base.py
index 12c0f9bb3..0dc7db3f6 100644
--- a/numpy/lib/twodim_base.py
+++ b/numpy/lib/twodim_base.py
@@ -25,7 +25,7 @@ def fliplr(m):
Parameters
----------
m : array_like
- Input array.
+ Input array, must be at least 2-D.
Returns
-------
@@ -40,8 +40,7 @@ def fliplr(m):
Notes
-----
- Equivalent to A[:,::-1]. Does not require the array to be
- two-dimensional.
+ Equivalent to A[:,::-1]. Requires the array to be at least 2-D.
Examples
--------