Add rrulewrapper to docs #23048
Add rrulewrapper to docs #23048
Conversation
|
It works, although the documentation could be more verbose: |
|
Will improve the doc-strings and re-add links to rrulewrapper in the documentation. |
1ddb753 to
2915f1f
Compare
2915f1f to
843181b
Compare
843181b to
3b53e9d
Compare
|
|
| @@ -981,16 +981,28 @@ def __call__(self, x, pos=None): | |||
|
|
|||
| class rrulewrapper: | |||
| """ | |||
| A simple wrapper around a ``dateutil.rrule`` allowing flexible | |||
| A simple wrapper around a `dateutil.rrule` allowing flexible | |||
| date tick specifications. | |||
There was a problem hiding this comment.
Can we add some clue here as to how this is supposed to be used? There are no documented methods on the class, which is probably fine, but as it stands this is kind of mysterious. Maybe:
| date tick specifications. | |
| date tick specifications. Usually passed upon init to a subclass of `RRuleLocator`. |
I will say that adding this wrapper seems a bit cumbersome versus just passing freq, tzinfo etc to the RRuleLocator directly. If it were up to me, I'd deprecate rrulewrapper as public and get rid of it all together.
There was a problem hiding this comment.
OK! I do not have any strong opinions on it. Clearly people have managed without it being documented for quite some time now.
There was a problem hiding this comment.
Well I doubt we will deprecate it now - lets improve the docs even if it doesn't stick around.
|
Lets just go ahead and merge this - I'll follow up with something to deprecate this wrapper, maybe for 3.7 |
PR Summary
Closes #21880
Builds on #21993
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).