DOC: Add examples to frequency classes and methods #48011
Merged
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
attack68
reviewed
Aug 10, 2022
| @@ -559,6 +607,20 @@ cdef class BaseOffset: | |||
|
|
|||
| @cache_readonly | |||
| def freqstr(self) -> str: | |||
| """ | |||
| Return a string representing the frequency. | |||
There was a problem hiding this comment.
How does this differ from the name? i.e. is there a diff between,
>>> pd.offsets.Hour(5).name # which is "H" in above example
>>> pd.offsets.Hour(5).freqstr
?
There was a problem hiding this comment.
AFAIU: name is the "base" frequency unit (H), and freqstr is the entire frequency with its multiple (5H).
Added additional examples to name and freqstr to clarify this
attack68
reviewed
Aug 10, 2022
| dt : datetime.datetime | ||
| Timestamp to check intersections with frequency. | ||
|
|
||
| Examples |
There was a problem hiding this comment.
Could we get an example where this is False as well. Think this might be useful.
There was a problem hiding this comment.
Good idea. Added an example which returns False
attack68
reviewed
Aug 10, 2022
pandas/_libs/tslibs/offsets.pyx
Outdated
| @@ -745,26 +822,96 @@ cdef class BaseOffset: | |||
| def is_anchored(self) -> bool: | |||
| # TODO: Does this make sense for the general case? It would help | |||
| # if there were a canonical docstring for what is_anchored means. | |||
| """ | |||
| Return boolean whether the frequency is a unit frequency. | |||
There was a problem hiding this comment.
I don't understand this - but I don't use these functions frequently.
There was a problem hiding this comment.
Added a note here that unit means (n=1)
attack68
approved these changes
Aug 10, 2022
noatamir
pushed a commit
to noatamir/pandas
that referenced
this pull request
Nov 9, 2022
* Add examples to offsets * Finish examples for offsets * Finish examples for offsets * Undo API removals, fix failures * Address review
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.
The goal is to eventually enable the
EX01(all docstrings have examples), so adding simple examples to the public frequency classes and methods.