diff options
| author | Hans Meine <hans_meine@gmx.net> | 2014-03-15 06:58:24 +0100 |
|---|---|---|
| committer | Hans Meine <hans_meine@gmx.net> | 2014-03-15 07:11:22 +0100 |
| commit | e86077ab5a742b8fd81a137c946a551752f237f4 (patch) | |
| tree | 7e11c7ff8d86d05edbd1d406fb43510f2705f52b /doc | |
| parent | 17227ce130cae09f03c55df1ed22798be901c7ff (diff) | |
| download | numpy-e86077ab5a742b8fd81a137c946a551752f237f4.tar.gz | |
doc fixes to 'array-protocol type strings'
The item size is not always used (and not always means exact bytes), and
'O' was not in the table.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/reference/arrays.dtypes.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/source/reference/arrays.dtypes.rst b/doc/source/reference/arrays.dtypes.rst index 2fc1add99..797f1f6f8 100644 --- a/doc/source/reference/arrays.dtypes.rst +++ b/doc/source/reference/arrays.dtypes.rst @@ -220,16 +220,20 @@ One-character strings Array-protocol type strings (see :ref:`arrays.interface`) The first character specifies the kind of data and the remaining - characters specify how many bytes of data. The supported kinds are + characters specify the number of bytes per item. The item size may + be ignored for some kinds (i.e., boolean, object), rounded to the + next supported size (float, complex), or interpreted as the number + of characters (Unicode). The supported kinds are ================ ======================== - ``'b'`` Boolean + ``'b'`` boolean ``'i'`` (signed) integer ``'u'`` unsigned integer ``'f'`` floating-point ``'c'`` complex-floating point - ``'S'``, ``'a'`` string - ``'U'`` unicode + ``'O'`` (Python) objects + ``'S'``, ``'a'`` (byte-)string + ``'U'`` Unicode ``'V'`` raw data (:class:`void`) ================ ======================== |