Fix docstrings for pandas.Period.month #59517
Merged
Conversation
This file contains 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
pandas/_libs/tslibs/period.pyx
Outdated
| """ | ||
| Return the month this Period falls on. | ||
| """ |
There was a problem hiding this comment.
in indent was correct before
There was a problem hiding this comment.
Thanks for the feedback. I've updated the indentation of the function in pandas/_libs/tslibs/period.pyx.
If you have any further suggestions or if there's anything specific you’d like me to address, please let me know!
pandas/_libs/tslibs/period.pyx
Outdated
Comment on lines
2052
to
2062
| Handle a case where the Period object is invalid or empty, which results in `NaN`: | ||
|
|
||
| >>> period = pd.Period('nan', 'M') | ||
| >>> period.month | ||
| nan | ||
|
|
||
| Handle a case where the Period object is invalid or empty, which results in `NaN`: | ||
|
|
||
| >>> period = pd.Period('nan', 'M') | ||
| >>> period.month | ||
| nan |
|
thnx, please check ci failure |
mroeschke
approved these changes
Aug 15, 2024
|
Thanks @uditbaliyan |
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.
Part of #59458
Addresses:
pandas.Period.month having SA01
pandas.Period.asfreq SA01
Changes:
Added See Also section .
Added Returns section .
Added extended section .
Added notes section .
Added examples section .
Removed "pandas.Period.month SA01" and "pandas.Period.asfreq SA01" from code_checks.sh