Skip to content

Commit e19dbee

Browse files
authored
DOC: fix RT03 for CategoricalIndex.set_categories, DataFrame.astype, DataFrame.at_time and DataFrame.ewm (#57605)
* Add description of returned value of astype method * Add description text to return value of at_time method. * Add description for rreturn value of DataFrame.ewm method * Remove fixed methods from validation script exclusion * Change indentation in description
1 parent 6de3717 commit e19dbee

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

ci/code_checks.sh

-4
Original file line numberDiff line numberDiff line change
@@ -839,10 +839,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
839839

840840
MSG='Partially validate docstrings (RT03)' ; echo $MSG
841841
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT03 --ignore_functions \
842-
pandas.CategoricalIndex.set_categories\
843-
pandas.DataFrame.astype\
844-
pandas.DataFrame.at_time\
845-
pandas.DataFrame.ewm\
846842
pandas.DataFrame.expanding\
847843
pandas.DataFrame.filter\
848844
pandas.DataFrame.first_valid_index\

pandas/core/generic.py

+2
Original file line numberDiff line numberDiff line change
@@ -6197,6 +6197,7 @@ def astype(
61976197
Returns
61986198
-------
61996199
same type as caller
6200+
The pandas object casted to the specified ``dtype``.
62006201
62016202
See Also
62026203
--------
@@ -8675,6 +8676,7 @@ def at_time(self, time, asof: bool = False, axis: Axis | None = None) -> Self:
86758676
Returns
86768677
-------
86778678
Series or DataFrame
8679+
The values with the specified time.
86788680
86798681
Raises
86808682
------

pandas/core/window/ewm.py

+2
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,8 @@ class ExponentialMovingWindow(BaseWindow):
226226
Returns
227227
-------
228228
pandas.api.typing.ExponentialMovingWindow
229+
An instance of ExponentialMovingWindow for further exponentially weighted (EW)
230+
calculations, e.g. using the ``mean`` method.
229231
230232
See Also
231233
--------

0 commit comments

Comments
 (0)