Skip to content
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

DOC: Fix SA01 errors for DatetimeIndex methods #58325

Merged
merged 2 commits into from
Apr 19, 2024
Merged

DOC: Fix SA01 errors for DatetimeIndex methods #58325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1d9a3d
Fix SA01 errors for DatetimeIndex methods
shriyakalakata Apr 19, 2024
8c29f5b
Fix SA01 errors for DatetimeIndex methods
shriyakalakata Apr 19, 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
6 changes: 2 additions & 4 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeIndex.ceil SA01" \
-i "pandas.DatetimeIndex.date SA01" \
-i "pandas.DatetimeIndex.day SA01" \
-i "pandas.DatetimeIndex.day_name SA01" \
-i "pandas.DatetimeIndex.day_of_year SA01" \
-i "pandas.DatetimeIndex.dayofyear SA01" \
-i "pandas.DatetimeIndex.floor SA01" \
Expand All @@ -127,7 +126,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeIndex.microsecond SA01" \
-i "pandas.DatetimeIndex.minute SA01" \
-i "pandas.DatetimeIndex.month SA01" \
-i "pandas.DatetimeIndex.month_name SA01" \
-i "pandas.DatetimeIndex.nanosecond SA01" \
-i "pandas.DatetimeIndex.quarter SA01" \
-i "pandas.DatetimeIndex.round SA01" \
Expand Down Expand Up @@ -313,7 +311,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.components SA01" \
-i "pandas.Series.dt.date SA01" \
-i "pandas.Series.dt.day SA01" \
-i "pandas.Series.dt.day_name PR01,PR02,SA01" \
-i "pandas.Series.dt.day_name PR01,PR02" \
-i "pandas.Series.dt.day_of_year SA01" \
-i "pandas.Series.dt.dayofyear SA01" \
-i "pandas.Series.dt.days SA01" \
Expand All @@ -327,7 +325,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.microseconds SA01" \
-i "pandas.Series.dt.minute SA01" \
-i "pandas.Series.dt.month SA01" \
-i "pandas.Series.dt.month_name PR01,PR02,SA01" \
-i "pandas.Series.dt.month_name PR01,PR02" \
-i "pandas.Series.dt.nanosecond SA01" \
-i "pandas.Series.dt.nanoseconds SA01" \
-i "pandas.Series.dt.normalize PR01" \
Expand Down
8 changes: 8 additions & 0 deletions pandas/core/arrays/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1279,6 +1279,10 @@ def month_name(self, locale=None) -> npt.NDArray[np.object_]:
Series or Index
Series or Index of month names.

See Also
--------
DatetimeIndex.day_name : Return the day names with specified locale.

Examples
--------
>>> s = pd.Series(pd.date_range(start="2018-01", freq="ME", periods=3))
Expand Down Expand Up @@ -1336,6 +1340,10 @@ def day_name(self, locale=None) -> npt.NDArray[np.object_]:
Series or Index
Series or Index of day names.

See Also
--------
DatetimeIndex.month_name : Return the month names with specified locale.

Examples
--------
>>> s = pd.Series(pd.date_range(start="2018-01-01", freq="D", periods=3))
Expand Down