Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Series.dt.days #58528

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
May 2, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Series.dt.days #58528

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
9b5d57a
DOC: remove SA01 for pandas.Series.dt.days
tuhinsharma121 May 2, 2024
a43c0cf
DOC: remove SA01 for pandas.TimedeltaIndex.days
tuhinsharma121 May 2, 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 @@ -185,7 +185,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.ceil PR01,PR02" \
-i "pandas.Series.dt.components SA01" \
-i "pandas.Series.dt.day_name PR01,PR02" \
-i "pandas.Series.dt.days SA01" \
-i "pandas.Series.dt.days_in_month SA01" \
-i "pandas.Series.dt.daysinmonth SA01" \
-i "pandas.Series.dt.floor PR01,PR02" \
Expand Down Expand Up @@ -312,7 +311,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timedelta.view SA01" \
-i "pandas.TimedeltaIndex.as_unit RT03,SA01" \
-i "pandas.TimedeltaIndex.components SA01" \
-i "pandas.TimedeltaIndex.days SA01" \
-i "pandas.TimedeltaIndex.microseconds SA01" \
-i "pandas.TimedeltaIndex.nanoseconds SA01" \
-i "pandas.TimedeltaIndex.seconds SA01" \
Expand Down
6 changes: 6 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 @@ -799,6 +799,12 @@ def to_pytimedelta(self) -> npt.NDArray[np.object_]:
days_docstring = textwrap.dedent(
"""Number of days for each element.

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

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