summaryrefslogtreecommitdiff
path: root/doc/source/reference/c-api.array.rst
diff options
context:
space:
mode:
authorJulian Taylor <jtaylor.debian@googlemail.com>2014-02-03 20:01:07 +0100
committerJulian Taylor <jtaylor.debian@googlemail.com>2014-02-11 19:30:21 +0100
commit2facd5cbdcaa08b61270c0c0760a39cd03acc007 (patch)
tree7001911b928ecc830184633e209bd052073d6895 /doc/source/reference/c-api.array.rst
parentb7850701a31127cad8c7399cea6be9cd5f71bec5 (diff)
downloadnumpy-2facd5cbdcaa08b61270c0c0760a39cd03acc007.tar.gz
ENH: add tobytes and stop using tostring in documentation
tostring returns bytes which are not equal to string, so provide a tobytes function alias. tostring does not emit a deprecation warning yet so rdepends do not need to check two names to support older versions of numpy without warnings.
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
-rw-r--r--doc/source/reference/c-api.array.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst
index 6e68a9a0e..323ca0655 100644
--- a/doc/source/reference/c-api.array.rst
+++ b/doc/source/reference/c-api.array.rst
@@ -1574,7 +1574,7 @@ Conversion
.. cfunction:: PyObject* PyArray_ToString(PyArrayObject* self, NPY_ORDER order)
- Equivalent to :meth:`ndarray.tostring` (*self*, *order*). Return the bytes
+ Equivalent to :meth:`ndarray.tobytes` (*self*, *order*). Return the bytes
of this array in a Python string.
.. cfunction:: PyObject* PyArray_ToFile(PyArrayObject* self, FILE* fp, char* sep, char* format)