Skip to content

Commit 085b919

Browse files
Doc: fix SA01 errors for pandas.BooleanDtype and pandas.StringDtype (#57802)
fix SA01 errors for pandas.BooleanDtype and pandas.StringDtype
1 parent 8813953 commit 085b919

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
857857

858858
MSG='Partially validate docstrings (SA01)' ; echo $MSG
859859
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA01 --ignore_functions \
860-
pandas.BooleanDtype\
861860
pandas.Categorical.__array__\
862861
pandas.Categorical.as_ordered\
863862
pandas.Categorical.as_unordered\
@@ -1169,7 +1168,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
11691168
pandas.Series.update\
11701169
pandas.Series.var\
11711170
pandas.SparseDtype\
1172-
pandas.StringDtype\
11731171
pandas.Timedelta\
11741172
pandas.Timedelta.as_unit\
11751173
pandas.Timedelta.asm8\

pandas/core/arrays/boolean.py

+4
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ class BooleanDtype(BaseMaskedDtype):
5656
-------
5757
None
5858
59+
See Also
60+
--------
61+
StringDtype : Extension dtype for string data.
62+
5963
Examples
6064
--------
6165
>>> pd.BooleanDtype()

pandas/core/arrays/string_.py

+4
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ class StringDtype(StorageExtensionDtype):
9292
-------
9393
None
9494
95+
See Also
96+
--------
97+
BooleanDtype : Extension dtype for boolean data.
98+
9599
Examples
96100
--------
97101
>>> pd.StringDtype()

0 commit comments

Comments
 (0)