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.

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: fixing SA01 error for DatetimeIndex: second, nanosecond, and microsecond #58342

Merged
merged 2 commits into from
Apr 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DataFrame.var PR01,RT03,SA01" \
-i "pandas.DatetimeIndex.ceil SA01" \
-i "pandas.DatetimeIndex.date SA01" \
-i "pandas.DatetimeIndex.day SA01" \
-i "pandas.DatetimeIndex.day_of_year SA01" \
-i "pandas.DatetimeIndex.dayofyear SA01" \
-i "pandas.DatetimeIndex.floor SA01" \
Expand All @@ -118,8 +117,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-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.nanosecond SA01" \
-i "pandas.DatetimeIndex.quarter SA01" \
-i "pandas.DatetimeIndex.round SA01" \
-i "pandas.DatetimeIndex.snap PR01,RT03,SA01" \
Expand Down Expand Up @@ -296,7 +293,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.ceil PR01,PR02,SA01" \
-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" \
-i "pandas.Series.dt.day_of_year SA01" \
-i "pandas.Series.dt.dayofyear SA01" \
Expand All @@ -306,10 +302,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.floor PR01,PR02,SA01" \
-i "pandas.Series.dt.freq GL08" \
-i "pandas.Series.dt.is_leap_year SA01" \
-i "pandas.Series.dt.microsecond SA01" \
-i "pandas.Series.dt.microseconds 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" \
Expand Down
16 changes: 16 additions & 0 deletions pandas/core/arrays/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1597,6 +1597,12 @@ def isocalendar(self) -> DataFrame:
"""
The day of the datetime.

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

Examples
--------
>>> datetime_series = pd.Series(
Expand Down Expand Up @@ -1706,6 +1712,11 @@ def isocalendar(self) -> DataFrame:
"""
The microseconds of the datetime.

See Also
--------
DatetimeIndex.second: The seconds of the datetime.
DatetimeIndex.nanosecond: The nanoseconds of the datetime.

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

See Also
--------
DatetimeIndex.second: The seconds of the datetime.
DatetimeIndex.microsecond: The microseconds of the datetime.

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