Skip to content

Added docstring to rrulewrapper class #21993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from Dec 21, 2021
Merged

Added docstring to rrulewrapper class #21993

merged 4 commits into from Dec 21, 2021

Conversation

ghost
Copy link

@ghost ghost commented Dec 17, 2021

@StefRe
Copy link
Contributor

StefRe commented Dec 17, 2021

hm, the docstring alone doesn't appear to have any effect - see here and here.

@@ -980,6 +980,11 @@ def __call__(self, x, pos=None):


class rrulewrapper:
"""
A simple wrapper around a ``dateutil.rrule`` allowing almost
arbitrary date tick specifications.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "allowing flexible date tick ...".

@tacaswell tacaswell added this to the v3.6.0 milestone Dec 17, 2021
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! It looks like it's failing our flake8 tests. Could you fix this? It looks like there just a blank line that needs deleting.

@ghost
Copy link
Author

ghost commented Dec 21, 2021

@dstansby Thanks for the hint!

@timhoffm timhoffm merged commit b57506e into matplotlib:main Dec 21, 2021
@ghost ghost deleted the add_rrulewrapper_docstring branch December 22, 2021 07:31
@oscargus oscargus mentioned this pull request May 14, 2022
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants