DOC: Add reference to frequency strings #13632
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
Contributor
sahildua2305
commented
Jul 12, 2016
•
sahildua2305
commented
- closes The documentation around frequency strings is unclear #13160
sahildua2305
changed the title
sahildua2305
changed the title
| @@ -312,6 +312,9 @@ class Window(_Window): | |||
| * ``gaussian`` (needs std) | |||
| * ``general_gaussian`` (needs power, width) | |||
| * ``slepian`` (needs width). | |||
|
|
|||
| To know more about the frequency strings (offset aliases), please visit this | |||
| link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases. | |||
There was a problem hiding this comment.
see how links are done, look at core/frame.py/to_latex.
To learn more about .....
|
lots of places where this can be added. asfreq, resample, Period, do a search. Once we decide on the text you can update. |
| into an instance of pandas ``DateOffset``, which represents a regular | ||
| frequency increment. Specific offset logic like "month", "business day", or | ||
| "one hour" is represented in its various subclasses. | ||
| frequencies by passing in :ref: `frequency strings <timeseries.offset_aliases>` |
There was a problem hiding this comment.
no space after the :ref:
Current coverage is 84.38%@@ master #13632 diff @@
==========================================
Files 138 142 +4
Lines 51095 51223 +128
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
+ Hits 43093 43224 +131
+ Misses 8002 7999 -3
Partials 0 0
|
|
@jreback please confirm the text once so that I can find and add the same at other places as well. |
| @@ -271,6 +271,9 @@ def rolling_count(arg, window, **kwargs): | |||
| The `freq` keyword is used to conform time series data to a specified | |||
| frequency by resampling the data. This is done with the default parameters | |||
| of :meth:`~pandas.Series.resample` (i.e. using the `mean`). | |||
|
|
|||
| To learn more about the frequency strings, please see `this link | |||
There was a problem hiding this comment.
these are all deprecated, but ok I guess.
|
@jorisvandenbossche lgtm. |
|
@sahildua2305 Thanks a lot! |
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.