diff options
author | Nathan Goldbaum <nathan.goldbaum@gmail.com> | 2022-12-15 09:42:45 -0700 |
---|---|---|
committer | Nathan Goldbaum <nathan.goldbaum@gmail.com> | 2022-12-15 09:42:45 -0700 |
commit | 921ba6db562777a7e099d0e15a32e013514293bc (patch) | |
tree | 81788c713624891b23bbe9318675f963456f5abb /doc | |
parent | 458ee6443b8cb25407cc8d75b83254ee7eae4a9e (diff) | |
download | numpy-921ba6db562777a7e099d0e15a32e013514293bc.tar.gz |
DOC: update discussion in dtypes docs that references Python 2
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/reference/arrays.dtypes.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/source/reference/arrays.dtypes.rst b/doc/source/reference/arrays.dtypes.rst index 8606bc8f1..2f0ace0a7 100644 --- a/doc/source/reference/arrays.dtypes.rst +++ b/doc/source/reference/arrays.dtypes.rst @@ -188,10 +188,10 @@ Built-in Python types (all others) :class:`object_` ================ =============== - Note that ``str`` refers to either null terminated bytes or unicode strings - depending on the Python version. In code targeting both Python 2 and 3 - ``np.unicode_`` should be used as a dtype for strings. - See :ref:`Note on string types<string-dtype-note>`. + Note that ``str`` corresponds to UCS4 encoded unicode strings, while + ``string`` is an alias to ``bytes_``. The name `np.unicode_` is also + available as an alias to `np.str_`, see :ref:`Note on string + types<string-dtype-note>`. .. admonition:: Example @@ -263,11 +263,11 @@ Array-protocol type strings (see :ref:`arrays.interface`) .. admonition:: Note on string types - For backward compatibility with Python 2 the ``S`` and ``a`` typestrings - remain zero-terminated bytes and `numpy.string_` continues to alias - `numpy.bytes_`. To use actual strings in Python 3 use ``U`` or `numpy.str_`. - For signed bytes that do not need zero-termination ``b`` or ``i1`` can be - used. + For backward compatibility with existing code originally written to support + Python 2 ``S`` and ``a`` typestrings are zero-terminated bytes and + `numpy.string_` continues to alias `numpy.bytes_`. For unicode strings, + use ``U``, `numpy.str_`, or `numpy.unicode_`. For signed bytes that do not + need zero-termination ``b`` or ``i1`` can be used. String with comma-separated fields A short-hand notation for specifying the format of a structured data type is |