summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py6
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',