Skip to content

Commit 7a3207f

Browse files
committed
DOC: Fix warning directive and adjust BooleanDtype docstring attributes (fixes #61939)
1 parent e5ec311 commit 7a3207f

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

pandas/core/arrays/boolean.py

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@ class BooleanDtype(BaseMaskedDtype):
4949
arrays in pandas objects.
5050
5151
.. warning::
52-
53-
BooleanDtype is considered experimental. The implementation and
54-
parts of the API may change without warning.
52+
BooleanDtype is considered experimental. The implementation and
53+
parts of the API may change without warning.
5554
5655
Attributes
5756
----------
@@ -76,6 +75,33 @@ class BooleanDtype(BaseMaskedDtype):
7675
Examples
7776
--------
7877
Create a Series with BooleanDtype:
78+
=======
79+
BooleanDtype is considered experimental. The implementation and
80+
parts of the API may change without warning.
81+
82+
Attributes
83+
----------
84+
name : str
85+
String identifying the dtype ('boolean').
86+
kind : str
87+
The kind of data ('b' for boolean).
88+
numpy_dtype : numpy.dtype
89+
The underlying NumPy dtype used ('bool').
90+
type : type
91+
The scalar type for elements of this dtype (np.bool_).
92+
93+
94+
See Also
95+
--------
96+
BooleanArray : Extension array for boolean data with missing values.
97+
StringDtype : Extension dtype for string data.
98+
array : Create a pandas array with a specific dtype.
99+
Series : One-dimensional ndarray with axis labels.
100+
DataFrame : Two-dimensional, size-mutable, tabular data.
101+
102+
Examples
103+
--------
104+
Create a Series with BooleanDtype:
79105
80106
>>> s = pd.Series([True, False, None], dtype="boolean")
81107
>>> s

0 commit comments

Comments
 (0)