Skip to content

Commit 6dfedda

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.api.extensions.register_extension_dtype (#58614)
* DOC: remove SA01 for pandas.api.extensions.register_extension_dtype * DOC: remove SA01 for pandas.api.extensions.register_extension_dtype * DOC: add SA01 for pandas.api.extensions.register_extension_dtype
1 parent fa59ac4 commit 6dfedda

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
368368
-i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
369369
-i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \
370370
-i "pandas.api.extensions.ExtensionArray.view SA01" \
371-
-i "pandas.api.extensions.register_extension_dtype SA01" \
372371
-i "pandas.api.indexers.BaseIndexer PR01,SA01" \
373372
-i "pandas.api.indexers.FixedForwardWindowIndexer PR01,SA01" \
374373
-i "pandas.api.indexers.VariableOffsetWindowIndexer PR01,SA01" \

pandas/core/dtypes/base.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,14 @@ def register_extension_dtype(cls: type_t[ExtensionDtypeT]) -> type_t[ExtensionDt
486486
callable
487487
A class decorator.
488488
489+
See Also
490+
--------
491+
api.extensions.ExtensionDtype : The base class for creating custom pandas
492+
data types.
493+
Series : One-dimensional array with axis labels.
494+
DataFrame : Two-dimensional, size-mutable, potentially heterogeneous
495+
tabular data.
496+
489497
Examples
490498
--------
491499
>>> from pandas.api.extensions import register_extension_dtype, ExtensionDtype

0 commit comments

Comments
 (0)