diff options
| author | Allan Haldane <allan.haldane@gmail.com> | 2016-10-18 17:12:55 -0400 |
|---|---|---|
| committer | Allan Haldane <allan.haldane@gmail.com> | 2016-10-18 17:12:55 -0400 |
| commit | 4733b0047c04e15b69d359fa347378a6399fd10b (patch) | |
| tree | 1c91d829ba9997353587ebdac78e2ce05fd7b20c /numpy/add_newdocs.py | |
| parent | 9bafab42c5d5b11023ef33622be425fc54584d6f (diff) | |
| download | numpy-4733b0047c04e15b69d359fa347378a6399fd10b.tar.gz | |
DOC: warn that dtype.descr is only for use in PEP3118
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index da87bc29e..62faf09fe 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -6171,11 +6171,13 @@ add_newdoc('numpy.core.multiarray', 'dtype', ('char', add_newdoc('numpy.core.multiarray', 'dtype', ('descr', """ - Array-interface compliant full description of the data-type. + PEP3118 interface description of the data-type. The format is that required by the 'descr' key in the - `__array_interface__` attribute. + PEP3118 `__array_interface__` attribute. + Warning: This attribute exists specifically for PEP3118 compliance, and + is not a datatype description compatible with `np.dtype`. """)) add_newdoc('numpy.core.multiarray', 'dtype', ('fields', |