DOC: Validate docstrings for pandas.Period.freq #62427
Closed
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
- Convert freq from cdef readonly to @Property with proper docstring - Add comprehensive NumPy-style docstring following pandas standards - Include Returns, See Also, and Examples sections - Remove pandas.Period.freq GL08 from ci/code_checks.sh ignore list Part of pandas-dev#58063
- Remove trailing whitespace from blank lines - Fix formatting to pass CI pre-commit hooks
| self._dtype = PeriodDtypeBase(freq._period_dtype_code, freq.n) | ||
|
|
||
| @property | ||
| def freq(self) -> BaseOffset: |
Member
There was a problem hiding this comment.
this change is going to (slightly) slow down a lot of methods. im not sure its worth it
Author
There was a problem hiding this comment.
this is my first contribution I was just trying to get started and understand how to deal with contributing, any ways thank you for the comment I will start something else that may be a better fit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
closes #58063 (partially)
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.This PR validates and fixes the docstring for
pandas.Period.freqto conform with the NumPy docstring standard.The following changes were made:
• Converted the
freqattribute from acdef readonlyCython attribute to a Python property to enable proper docstring documentation, resolving aGL08validation error.• Added a fully-featured docstring (including
Returns,See Also, andExamplessections) to the.freqproperty following NumPy docstring standards.• Removed the now-passing method from the ignore list in
ci/code_checks.sh.