Skip to content

DOC: Fix SA01 for pandas.Series.dt.nanoseconds and pandas.Series.dt.seconds. #59741

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

Closed
wants to merge 3 commits into from
Closed

DOC: Fix SA01 for pandas.Series.dt.nanoseconds and pandas.Series.dt.seconds. #59741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5963e24
Documentation update for dt.nanoseconds and dt.seconds
chalky25 Sep 6, 2024
5e1a4a9
Documentation update for dt.nanoseconds and dt.seconds
chalky25 Sep 7, 2024
cbef2f2
Merge branch 'main' into documentation_changes
chalky25 Sep 7, 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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.floor PR01,PR02" \
-i "pandas.Series.dt.freq GL08" \
-i "pandas.Series.dt.month_name PR01,PR02" \
-i "pandas.Series.dt.nanoseconds SA01" \
-i "pandas.Series.dt.normalize PR01" \
-i "pandas.Series.dt.round PR01,PR02" \
-i "pandas.Series.dt.seconds SA01" \
-i "pandas.Series.dt.strftime PR01,PR02" \
-i "pandas.Series.dt.to_period PR01,PR02" \
-i "pandas.Series.dt.total_seconds PR01" \
Expand Down
16 changes: 16 additions & 0 deletions pandas/core/arrays/timedeltas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,14 @@ def to_pytimedelta(self) -> npt.NDArray[np.object_]:
seconds_docstring = textwrap.dedent(
"""Number of seconds (>= 0 and less than 1 day) for each element.

The dt.seconds attribute in pandas extracts the number of seconds (excluding days)
from a timedelta64[ns] object. It can be used with Series and TimedeltaIndex.

See Also
--------
Series.dt.microseconds : Returns number of microseconds for each element.
Series.dt.nanoseconds : Returns number of nanoseconds for each element.

Examples
--------
For Series:
Expand Down Expand Up @@ -917,6 +925,14 @@ def to_pytimedelta(self) -> npt.NDArray[np.object_]:
nanoseconds_docstring = textwrap.dedent(
"""Number of nanoseconds (>= 0 and less than 1 microsecond) for each element.

The dt.nanoseconds attribute in pandas extracts the number of nanoseconds
from a timedelta64[ns] object. It can be used with Series and TimedeltaIndex.

See Also
--------
Series.dt.seconds : Returns number of seconds for each element.
Series.dt.microseconds : Returns number of microseconds for each element.

Examples
--------
For Series:
Expand Down
Loading