summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorMark Wiebe <mwiebe@enthought.com>2011-06-01 09:31:20 -0500
committerMark Wiebe <mwiebe@enthought.com>2011-06-01 09:31:20 -0500
commit7d5b355aad0a425c01cbff807e6b1ac742be5b54 (patch)
tree00a62ee3d5b50d9740d418f62fb05dfa58225805 /numpy/add_newdocs.py
parenta17a4996e4ed63d1b855a0917fb5fcdd5855a7d0 (diff)
downloadnumpy-7d5b355aad0a425c01cbff807e6b1ac742be5b54.tar.gz
ENH: core: Rename forcecopy= to copy= in ndarray.astype
This makes it match the parameter in the array constructor with the same meaning.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index e596607fa..20ce6c378 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -3001,7 +3001,7 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('argsort',
add_newdoc('numpy.core.multiarray', 'ndarray', ('astype',
"""
- a.astype(dtype, order='K', casting='unsafe', subok=True, forcecopy=True)
+ a.astype(dtype, order='K', casting='unsafe', subok=True, copy=True)
Copy of the array, cast to a specified type.
@@ -3029,10 +3029,11 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('astype',
subok : bool, optional
If True, then sub-classes will be passed-through (default), otherwise
the returned array will be forced to be a base-class array.
- forcecopy : bool, optional
- By default, astype always returns a new array. If this is set to
- false, and the `dtype`, `order`, and `subok` requirements are
- satisfied, the input array is returned instead of a copy.
+ copy : bool, optional
+ By default, astype always returns a newly allocated array. If this
+ is set to false, and the `dtype`, `order`, and `subok`
+ requirements are satisfied, the input array is returned instead
+ of a copy.
Raises
------