Skip to content

DOC: removing SA01 errors for DateTimeIndex: hour, minute, and second. #58331

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 2 commits into from
Apr 20, 2024
Merged

DOC: removing SA01 errors for DateTimeIndex: hour, minute, and second. #58331

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
360c57d
doc: removing SA01 errors for datetimeIndex: hour, minute, second
KeiOshima Apr 19, 2024
7292ca3
fixing docString error
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
6 changes: 0 additions & 6 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,17 +118,14 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeIndex.dayofyear SA01" \
-i "pandas.DatetimeIndex.floor SA01" \
-i "pandas.DatetimeIndex.freqstr SA01" \
-i "pandas.DatetimeIndex.hour SA01" \
-i "pandas.DatetimeIndex.indexer_at_time PR01,RT03" \
-i "pandas.DatetimeIndex.indexer_between_time RT03" \
-i "pandas.DatetimeIndex.inferred_freq SA01" \
-i "pandas.DatetimeIndex.is_leap_year SA01" \
-i "pandas.DatetimeIndex.microsecond SA01" \
-i "pandas.DatetimeIndex.minute SA01" \
-i "pandas.DatetimeIndex.nanosecond SA01" \
-i "pandas.DatetimeIndex.quarter SA01" \
-i "pandas.DatetimeIndex.round SA01" \
-i "pandas.DatetimeIndex.second SA01" \
-i "pandas.DatetimeIndex.snap PR01,RT03,SA01" \
-i "pandas.DatetimeIndex.std PR01,RT03" \
-i "pandas.DatetimeIndex.time SA01" \
Expand Down Expand Up @@ -317,19 +314,16 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.daysinmonth SA01" \
-i "pandas.Series.dt.floor PR01,PR02,SA01" \
-i "pandas.Series.dt.freq GL08" \
-i "pandas.Series.dt.hour SA01" \
-i "pandas.Series.dt.is_leap_year SA01" \
-i "pandas.Series.dt.microsecond SA01" \
-i "pandas.Series.dt.microseconds SA01" \
-i "pandas.Series.dt.minute 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" \
-i "pandas.Series.dt.quarter SA01" \
-i "pandas.Series.dt.qyear GL08" \
-i "pandas.Series.dt.round PR01,PR02,SA01" \
-i "pandas.Series.dt.second SA01" \
-i "pandas.Series.dt.seconds SA01" \
-i "pandas.Series.dt.strftime PR01,PR02" \
-i "pandas.Series.dt.time SA01" \
Expand Down
17 changes: 17 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 @@ -1620,6 +1620,12 @@ def isocalendar(self) -> DataFrame:
"""
The hours of the datetime.

See Also
--------
DatetimeIndex.day: The day of the datetime.
DatetimeIndex.minute: The minutes of the datetime.
DatetimeIndex.second: The seconds of the datetime.

Examples
--------
>>> datetime_series = pd.Series(
Expand All @@ -1643,6 +1649,11 @@ def isocalendar(self) -> DataFrame:
"""
The minutes of the datetime.

See Also
--------
DatetimeIndex.hour: The hours of the datetime.
DatetimeIndex.second: The seconds of the datetime.

Examples
--------
>>> datetime_series = pd.Series(
Expand All @@ -1666,6 +1677,12 @@ def isocalendar(self) -> DataFrame:
"""
The seconds of the datetime.

See Also
--------
DatetimeIndex.minute: The minutes of the datetime.
DatetimeIndex.microsecond: The microseconds of the datetime.
DatetimeIndex.nanosecond: The nanoseconds of the datetime.

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