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.month and DatetimeIndex.year #58326

Merged
merged 5 commits into from
Apr 19, 2024
Merged

DOC: Fix SA01 errors for DatetimeIndex.month and DatetimeIndex.year #58326

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
48709cc
Fixing doc string for DatetimeIndex.month and DatetimeIndex.year
KeiOshima Apr 19, 2024
f82a45f
fixing at pandas.Series code_checks
KeiOshima Apr 19, 2024
dc30159
Merge branch 'main' into doc-DatetimeIndex-year
KeiOshima Apr 19, 2024
6a97448
fixing merge conflict
KeiOshima Apr 19, 2024
a4f5157
Merge remote changes
KeiOshima 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
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 @@ -125,7 +125,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeIndex.is_leap_year SA01" \
-i "pandas.DatetimeIndex.microsecond SA01" \
-i "pandas.DatetimeIndex.minute SA01" \
-i "pandas.DatetimeIndex.month SA01" \
-i "pandas.DatetimeIndex.nanosecond SA01" \
-i "pandas.DatetimeIndex.quarter SA01" \
-i "pandas.DatetimeIndex.round SA01" \
Expand All @@ -138,7 +137,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeIndex.to_pydatetime RT03,SA01" \
-i "pandas.DatetimeIndex.tz SA01" \
-i "pandas.DatetimeIndex.tz_convert RT03" \
-i "pandas.DatetimeIndex.year SA01" \
-i "pandas.DatetimeTZDtype SA01" \
-i "pandas.DatetimeTZDtype.tz SA01" \
-i "pandas.DatetimeTZDtype.unit SA01" \
Expand Down Expand Up @@ -324,7 +322,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.microsecond SA01" \
-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" \
-i "pandas.Series.dt.nanosecond SA01" \
-i "pandas.Series.dt.nanoseconds SA01" \
Expand All @@ -343,7 +340,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.tz_convert PR01,PR02,RT03" \
-i "pandas.Series.dt.tz_localize PR01,PR02" \
-i "pandas.Series.dt.unit GL08" \
-i "pandas.Series.dt.year SA01" \
-i "pandas.Series.dtype SA01" \
-i "pandas.Series.empty GL08" \
-i "pandas.Series.eq PR07,SA01" \
Expand Down
10 changes: 10 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 @@ -1541,6 +1541,11 @@ def isocalendar(self) -> DataFrame:
"""
The year of the datetime.

See Also
--------
DatetimeIndex.month: The month as January=1, December=12.
DatetimeIndex.day: The day of the datetime.

Examples
--------
>>> datetime_series = pd.Series(
Expand All @@ -1564,6 +1569,11 @@ def isocalendar(self) -> DataFrame:
"""
The month as January=1, December=12.

See Also
--------
DatetimeIndex.year: The year of the datetime.
DatetimeIndex.day: The day of the datetime.

Examples
--------
>>> datetime_series = pd.Series(
Expand Down