summaryrefslogtreecommitdiff
path: root/doc/source/reference/arrays.scalars.rst
diff options
context:
space:
mode:
authorJulian Taylor <jtaylor.debian@googlemail.com>2017-04-13 20:24:04 +0200
committerJulian Taylor <jtaylor.debian@googlemail.com>2017-04-22 12:15:55 +0200
commit0107956102d914a68f157d80614f207f78dffb96 (patch)
treeb812f602843b45ad7091db8a6377c9130b54a9e3 /doc/source/reference/arrays.scalars.rst
parent0f3846aaabc7c1278e9aeab7aafa0b8d4a1b264e (diff)
downloadnumpy-0107956102d914a68f157d80614f207f78dffb96.tar.gz
DOC: stop refering to 'S' dtype as string
The S dtype is zero terminated bytes which happen to match what Python 2 called strings. As this is not the case in Python 3 we should stop naming it wrong in our documentation. [ci skip]
Diffstat (limited to 'doc/source/reference/arrays.scalars.rst')
-rw-r--r--doc/source/reference/arrays.scalars.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/source/reference/arrays.scalars.rst b/doc/source/reference/arrays.scalars.rst
index f76087ce2..9c4f05f75 100644
--- a/doc/source/reference/arrays.scalars.rst
+++ b/doc/source/reference/arrays.scalars.rst
@@ -71,7 +71,7 @@ Array scalar type Related Python type
:class:`int_` :class:`IntType` (Python 2 only)
:class:`float_` :class:`FloatType`
:class:`complex_` :class:`ComplexType`
-:class:`str_` :class:`StringType`
+:class:`bytes_` :class:`BytesType`
:class:`unicode_` :class:`UnicodeType`
==================== ================================
@@ -193,15 +193,17 @@ size: the data they describe can be of different length in different
arrays. (In the character codes ``#`` is an integer denoting how many
elements the data type consists of.)
-=================== ============================= ========
-:class:`str_` compatible: Python str ``'S#'``
-:class:`unicode_` compatible: Python unicode ``'U#'``
-:class:`void` ``'V#'``
-=================== ============================= ========
+=================== ============================== ========
+:class:`bytes_` compatible: Python bytes ``'S#'``
+:class:`unicode_` compatible: Python unicode/str ``'U#'``
+:class:`void` ``'V#'``
+=================== ============================== ========
.. warning::
+ See :ref:`Note on string types<string-dtype-note>`.
+
Numeric Compatibility: If you used old typecode characters in your
Numeric code (which was never recommended), you will need to change
some of them to the new characters. In particular, the needed