10000 Merge pull request #25680 from ngoldbaum/fix-dtype-classes-doc-warnings · mattip/numpy@756c276 · GitHub
[go: up one dir, main page]
Skip to content

Commit 756c276

Browse files
rgommersrgommers
authored
Merge pull request numpy#25680 from ngoldbaum/fix-dtype-classes-doc-warnings
DOC: replace autosummary for numpy.dtypes with enumerated list
2 parents 73cd3f1 + c0c1851 commit 756c276

File tree

2 files changed

+64
-39
lines changed
< 8000 button data-component="IconButton" type="button" aria-haspopup="true" aria-expanded="false" tabindex="0" class="prc-Button-ButtonBase-c50BI flex-shrink-0 prc-Button-IconButton-szpyj" data-loading="false" data-no-visuals="true" data-size="medium" data-variant="default" aria-describedby=":R55dab:-loading-announcement" aria-labelledby=":R3t5dab:" id=":R55dab:">

2 files changed

+64
-39
lines changed

‎doc/source/reference/routines.dtypes.rst

Lines changed: 64 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,69 @@
33
Data type classes
44
=================
55

6-
.. currentmodule:: numpy
6+
.. automodule:: numpy.dtypes
7+
:no-members:
78

8-
.. autosummary::
9-
:toctree: generated/
9+
Boolean
10+
-------
1011

11-
dtypes
12+
.. attribute:: BoolDType
13+
14+
Bit-sized integers
15+
------------------
16+
17+
.. attribute:: Int8DType
18+
UInt8DType
19+
Int16DType
20+
UInt16DType
21+
Int32DType
22+
UInt32DType
23+
Int64DType
24+
UInt64DType
25+
26+
C-named integers (may be aliases)
27+
---------------------------------
28+
29+
.. attribute:: ByteDType
30+
UByteDType
31+
ShortDType
32+
UShortDType
33+
IntDType
34+
UIntDType
35+
LongDType
36+
ULongDType
37+
LongLongDType
38+
ULongLongDType
39+
40+
Floating point
41+
--------------
42+
43+
.. attribute:: Float16DType
44+
Float32DType
45+
Float64DType
46+
LongDoubleDType
47+
48+
Complex
49+
-------
50+
51+
.. attribute:: Complex64DType
52+
Complex128DType
53+
CLongDoubleDType
54+
55+
Strings and Bytestrings
56+
-----------------------
57+
58+
.. attribute:: StrDType
59+
BytesDType
60+
61+
Times
62+
-----
63+
64+
.. attribute:: DateTime64DType
65+
TimeDelta64DType
66+
67+
Others
68+
------
69+
70+
.. attribute:: ObjectDType
71+
VoidDType

‎numpy/dtypes.py

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -20,41 +20,6 @@
2020
also be instantiated or used directly. Direct use of these classes is not
2121
typical, since their scalar counterparts (e.g. ``np.float64``) or strings
2222
like ``"float64"`` can be used.
23-
24-
.. list-table::
25-
:header-rows: 1
26-
27-
* - Group
28-
- DType class
29-
30-
* - Boolean
31-
- ``BoolDType``
32-
33-
* - Bit-sized integers
34-
- ``Int8DType``, ``UInt8DType``, ``Int16DType``, ``UInt16DType``,
35-
``Int32DType``, ``UInt32DType``, ``Int64DType``, ``UInt64DType``
36-
37-
* - C-named integers (may be aliases)
38-
- ``ByteDType``, ``UByteDType``, ``ShortDType``, ``UShortDType``,
39-
``IntDType``, ``UIntDType``, ``LongDType``, ``ULongDType``,
40-
``LongLongDType``, ``ULongLongDType``
41-
42-
* - Floating point
43-
- ``Float16DType``, ``Float32DType``, ``Float64DType``,
44-
``LongDoubleDType``
45-
46-
* - Complex
47-
- ``Complex64DType``, ``Complex128DType``, ``CLongDoubleDType``
48-
49-
* - Strings and Bytestrings
50-
- ``StrDType``, ``BytesDType``
51-
52-
* - Times
53-
- ``DateTime64DType``, ``TimeDelta64DType``
54-
55-
* - Others
56-
- ``ObjectDType``, ``VoidDType``
57-
5823
"""
5924

6025
__all__ = []

0 commit comments

Comments
 (0)
0