summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorJohn Goetz <j.goetz@tecplot.com>2017-10-25 11:17:54 -0700
committerJohn Goetz <j.goetz@tecplot.com>2017-10-25 13:24:52 -0700
commit7a07da1ebdcfb8d8e9f8599b2d23aa2ad17bbcdc (patch)
tree0729912afeb5fdc8a54413309c356db8f0c18fc2 /numpy/add_newdocs.py
parentc74551575999d0f036db744dde199373ea508e39 (diff)
downloadnumpy-7a07da1ebdcfb8d8e9f8599b2d23aa2ad17bbcdc.tar.gz
DOC: ndarray.reshape allows shape as int arguments or tuple
Adding note about difference between `numpy.reshape` and `ndarray.reshape`. See issue #570
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index ad18f18c8..eba532735 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -4125,6 +4125,13 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('reshape',
--------
numpy.reshape : equivalent function
+ Notes
+ -----
+ Unlike the free function `numpy.reshape`, this method on `ndarray` allows
+ the elements of the shape parameter to be passed in as separate arguments.
+ For example, ``a.reshape(10, 11)`` is equivalent to
+ ``a.reshape((10, 11))``.
+
"""))