Skip to content

DOC: fix RT03 for CategoricalIndex.set_categories, DataFrame.astype, DataFrame.at_time and DataFrame.ewm #57605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 26, 2024
Merged

DOC: fix RT03 for CategoricalIndex.set_categories, DataFrame.astype, DataFrame.at_time and DataFrame.ewm #57605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c9d791
Add description of returned value of astype method
Feb 24, 2024
3d9d8c9
Add description text to return value of at_time method.
Feb 24, 2024
fad93b8
Add description for rreturn value of DataFrame.ewm method
Feb 24, 2024
bb1f804
Remove fixed methods from validation script exclusion
Feb 24, 2024
2942619
Change indentation in description
Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1882,10 +1882,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Partially validate docstrings (RT03)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT03 --ignore_functions \
pandas.CategoricalIndex.set_categories\
pandas.DataFrame.astype\
pandas.DataFrame.at_time\
pandas.DataFrame.ewm\
pandas.DataFrame.expanding\
pandas.DataFrame.filter\
pandas.DataFrame.first_valid_index\
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6197,6 +6197,7 @@ def astype(
Returns
-------
same type as caller
The pandas object casted to the specified ``dtype``.

See Also
--------
Expand Down Expand Up @@ -8675,6 +8676,7 @@ def at_time(self, time, asof: bool = False, axis: Axis | None = None) -> Self:
Returns
-------
Series or DataFrame
The values with the specified time.

Raises
------
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/window/ewm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ class ExponentialMovingWindow(BaseWindow):
Returns
-------
pandas.api.typing.ExponentialMovingWindow
An instance of ExponentialMovingWindow for further exponentially weighted (EW)
calculations, e.g. using the ``mean`` method.

See Also
--------
Expand Down