From 555318cce84ed047901b20f253dc187e76c797e8 Mon Sep 17 00:00:00 2001 From: yuanx749 Date: Mon, 5 Feb 2024 16:48:00 +0800 Subject: [PATCH 1/2] DOC: fix PR02 errors in docstrings of Index subclasses --- ci/code_checks.sh | 20 -------------------- pandas/core/indexes/extension.py | 2 ++ 2 files changed, 2 insertions(+), 20 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index cebc8e976425b..5b65182d1c253 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -71,26 +71,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then MSG='Partially validate docstrings (PR02)' ; echo $MSG $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR02 --ignore_functions \ - pandas.CategoricalIndex.rename_categories\ - pandas.CategoricalIndex.reorder_categories\ - pandas.CategoricalIndex.add_categories\ - pandas.CategoricalIndex.remove_categories\ - pandas.CategoricalIndex.set_categories\ - pandas.IntervalIndex.set_closed\ - pandas.IntervalIndex.contains\ - pandas.IntervalIndex.overlaps\ - pandas.IntervalIndex.to_tuples\ - pandas.DatetimeIndex.round\ - pandas.DatetimeIndex.floor\ - pandas.DatetimeIndex.ceil\ - pandas.DatetimeIndex.month_name\ - pandas.DatetimeIndex.day_name\ - pandas.DatetimeIndex.to_period\ - pandas.DatetimeIndex.std\ - pandas.TimedeltaIndex.round\ - pandas.TimedeltaIndex.floor\ - pandas.TimedeltaIndex.ceil\ - pandas.PeriodIndex.strftime\ pandas.Series.dt.to_period\ pandas.Series.dt.tz_localize\ pandas.Series.dt.tz_convert\ diff --git a/pandas/core/indexes/extension.py b/pandas/core/indexes/extension.py index 61949531f37df..a6816551252fc 100644 --- a/pandas/core/indexes/extension.py +++ b/pandas/core/indexes/extension.py @@ -3,6 +3,7 @@ """ from __future__ import annotations +from inspect import signature from typing import ( TYPE_CHECKING, Callable, @@ -104,6 +105,7 @@ def method(self, *args, **kwargs): # type: ignore[misc] # error: "property" has no attribute "__name__" method.__name__ = name # type: ignore[attr-defined] method.__doc__ = attr.__doc__ + method.__signature__ = signature(attr) return method From c391dcb8521a90e4031149c3129564300d6f3269 Mon Sep 17 00:00:00 2001 From: yuanx749 Date: Mon, 5 Feb 2024 17:32:39 +0800 Subject: [PATCH 2/2] mypy --- pandas/core/indexes/extension.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/indexes/extension.py b/pandas/core/indexes/extension.py index a6816551252fc..d6fbeb9043bc6 100644 --- a/pandas/core/indexes/extension.py +++ b/pandas/core/indexes/extension.py @@ -105,7 +105,7 @@ def method(self, *args, **kwargs): # type: ignore[misc] # error: "property" has no attribute "__name__" method.__name__ = name # type: ignore[attr-defined] method.__doc__ = attr.__doc__ - method.__signature__ = signature(attr) + method.__signature__ = signature(attr) # type: ignore[attr-defined] return method