Skip to content

DOC: fix PR02 errors in docstring for pandas.tseries.offsets.DateOffset #57350

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 18 commits into from
Closed

DOC: fix PR02 errors in docstring for pandas.tseries.offsets.DateOffset #57350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
03b0967
Potential fix for PR02 errors in pandas.tseries.offsets
jordan-d-murphy Feb 11, 2024
f972fc5
fixing CI numpydoc docscrape UserWarning: potentially wrong underline…
jordan-d-murphy Feb 11, 2024
611957d
testing # numpydoc ignore=PR02 fix for failing CI warnings
jordan-d-murphy Feb 11, 2024
246d088
fixing docstring formatting
jordan-d-murphy Feb 11, 2024
224776a
format Ignore Validation Checks w Inline Comment
jordan-d-murphy Feb 11, 2024
5477a46
trying different comment format
jordan-d-murphy Feb 11, 2024
74c4e72
Fixing comment that is failing CI checks
jordan-d-murphy Feb 11, 2024
4a02b19
reverting to original comment
jordan-d-murphy Feb 11, 2024
9dc8e06
using single quote comment format for PR02 errors
jordan-d-murphy Feb 11, 2024
08e862e
update formatting to triple single quotes for CI check compat
jordan-d-murphy Feb 11, 2024
b7c5099
Merge branch 'main' into issue#57111_12
jordan-d-murphy Feb 11, 2024
e3cb1bb
Merge remote-tracking branch 'upstream/main' into issue#57111_12
jordan-d-murphy Feb 11, 2024
61a1a3c
Merge branch 'issue#57111_12' of https://github.com/jordan-d-murphy/p…
jordan-d-murphy Feb 11, 2024
565b300
reverting to original comment format for numpydoc ignore
jordan-d-murphy Feb 11, 2024
58f0520
inline comment whitespace
jordan-d-murphy Feb 11, 2024
a47efb9
fixing Doc Build unexpected unindent warning
jordan-d-murphy Feb 11, 2024
0b79001
testing single quote comments
jordan-d-murphy Feb 11, 2024
04be1e9
Merge branch 'main' into issue#57111_12
jordan-d-murphy Feb 13, 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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.Series.cat.set_categories\
pandas.Series.plot\
pandas.DataFrame.plot\
pandas.tseries.offsets.DateOffset\
pandas.tseries.offsets.BusinessDay\
pandas.tseries.offsets.BDay\
pandas.tseries.offsets.BusinessHour\
Expand Down
4 changes: 2 additions & 2 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1586,8 +1586,8 @@ class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta):
Besides, adding a DateOffsets specified by the singular form of the date
component can be used to replace certain component of the timestamp.

Parameters
----------
Parameters ''' numpydoc ignore=PR02 '''
---------- ''' numpydoc ignore=PR02 '''
n : int, default 1
The number of time periods the offset represents.
If specified without a temporal pattern, defaults to n days.
Expand Down