summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorMatthew Brett <matthew.brett@gmail.com>2012-09-13 13:55:16 +0100
committerMatthew Brett <matthew.brett@gmail.com>2012-09-13 13:55:16 +0100
commit5bfd65a55517e7a0af60d31e8dba6dc2f6b87df1 (patch)
treef69965b6047db73599c15e772c2ebbdb8e07df40 /numpy/add_newdocs.py
parenta17875bbf54d19a29621a173d177d56047ad4ad7 (diff)
downloadnumpy-5bfd65a55517e7a0af60d31e8dba6dc2f6b87df1.tar.gz
DOC: describe output from astype method
Expand docstring for ``astype`` method.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index a416559db..f94a6964a 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -3067,6 +3067,14 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('astype',
requirements are satisfied, the input array is returned instead
of a copy.
+ Returns
+ -------
+ arr_t : ndarray
+ Unless `copy` is False and the other conditions for returning the input
+ array are satisfied (see description for `copy` input paramter), `arr_t`
+ is a new array of the same shape as the input array, with dtype, order
+ given by `dtype`, `order`.
+
Raises
------
ComplexWarning :