DOC: Enforce Numpy Docstring Validation for freqstr, nanos, and rule_code methods #59475
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…code methods of pandas.tseries.offsets Week, WeekOfMonth, YearBegin, and YearEnd classes.
…code methods of pandas.tseries.offsets Week, WeekOfMonth, YearBegin, and YearEnd classes.
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
ee3b016 to
756fbd4
Compare
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
2 times, most recently
from
2b2d912 to
53c7096
Compare
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
02ab3af to
72b141f
Compare
mroeschke
reviewed
Aug 12, 2024
pandas/_libs/tslibs/offsets.pyx
Outdated
|
|
||
| >>> pd.offsets.Week(5).rule_code | ||
| 'W' | ||
| """ # noqa |
There was a problem hiding this comment.
Can you fix these docstrings so we don't need a noqa? i.e. Put the Returns as string... indented on a new line?
There was a problem hiding this comment.
Thanks for your review! I have made these changes and also updated the other commits. I am getting a test error which I wasn't getting previously and I'm not sure why.
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
4411a37 to
edb3670
Compare
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
a2d9784 to
dedcd83
Compare
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
9454f41 to
ec59485
Compare
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
383550e to
e1c2879
Compare
mroeschke
reviewed
Aug 14, 2024
mroeschke
reviewed
Aug 14, 2024
mroeschke
reviewed
Aug 14, 2024
Siniade
force-pushed
the
58536-enforce-docstring-validation-offsets
branch
from
72d60db to
7186719
Compare
Delete two examples from See Also for nanos Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
Update nanos summary Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
Delete two examples from See Also for nanos Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com>
mroeschke
approved these changes
Aug 15, 2024
|
Thanks @Siniade |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dosctring Validation for freqstr, nanos, and rule_code methods of pandas.tseries.offsets Week, WeekOfMonth, YearBegin, and YearEnd classes.