diff options
| author | Cenny Wenner <cwenner@gmail.com> | 2018-06-09 21:03:09 +0200 |
|---|---|---|
| committer | Cenny Wenner <cwenner@gmail.com> | 2018-06-09 22:20:28 +0200 |
| commit | caab62bce506dc8aaaec1df8c85af8785bcef020 (patch) | |
| tree | 51828035af5d58a9d805ad7c3b4e90670e84acba /numpy | |
| parent | df618d5a5320917c642b40d0bc94c51cb08a6812 (diff) | |
| download | numpy-caab62bce506dc8aaaec1df8c85af8785bcef020.tar.gz | |
DOC: fix numericaltype hierarchy in code doc
Code documentation did not make clear the hierarchy for the types
`number`, `integer`, `unsignedinteger`, `signedinteger`,
`flexible`, `character`, and `void`; and their subdtypes.
This edit adds additional indentation and arrows in the
documentation style to indicate the type hierarchy.
This edit also adjusts whitespaces to align columns of
additional information (alises and kind shorthands) in the
documented hierarchy.
Diffstat (limited to 'numpy')
| -rw-r--r-- | numpy/core/numerictypes.py | 69 |
1 files changed, 34 insertions, 35 deletions
diff --git a/numpy/core/numerictypes.py b/numpy/core/numerictypes.py index 8ce3aba69..f7f25dd95 100644 --- a/numpy/core/numerictypes.py +++ b/numpy/core/numerictypes.py @@ -42,42 +42,41 @@ Exported symbols include: generic +-> bool_ (kind=b) +-> number - | integer - | signedinteger (intxx) (kind=i) - | byte - | short - | intc - | intp int0 - | int_ - | longlong - +-> unsignedinteger (uintxx) (kind=u) - | ubyte - | ushort - | uintc - | uintp uint0 - | uint_ - | ulonglong - +-> inexact - | +-> floating (floatxx) (kind=f) - | | half - | | single - | | float_ (double) - | | longfloat - | \\-> complexfloating (complexxx) (kind=c) - | csingle (singlecomplex) - | complex_ (cfloat, cdouble) - | clongfloat (longcomplex) + | +-> integer + | | +-> signedinteger (intxx) (kind=i) + | | | byte + | | | short + | | | intc + | | | intp int0 + | | | int_ + | | | longlong + | | \\-> unsignedinteger (uintxx) (kind=u) + | | ubyte + | | ushort + | | uintc + | | uintp uint0 + | | uint_ + | | ulonglong + | +-> inexact + | +-> floating (floatxx) (kind=f) + | | half + | | single + | | float_ (double) + | | longfloat + | \\-> complexfloating (complexxx) (kind=c) + | csingle (singlecomplex) + | complex_ (cfloat, cdouble) + | clongfloat (longcomplex) +-> flexible - | character - | void (kind=V) - | - | str_ (string_, bytes_) (kind=S) [Python 2] - | unicode_ (kind=U) [Python 2] - | - | bytes_ (string_) (kind=S) [Python 3] - | str_ (unicode_) (kind=U) [Python 3] - | - \\-> object_ (not used much) (kind=O) + | +-> character + | | str_ (string_, bytes_) (kind=S) [Python 2] + | | unicode_ (kind=U) [Python 2] + | | + | | bytes_ (string_) (kind=S) [Python 3] + | | str_ (unicode_) (kind=U) [Python 3] + | | + | \\-> void (kind=V) + \\-> object_ (not used much) (kind=O) """ from __future__ import division, absolute_import, print_function |