Skip to content

[Doc]: rrulewrapper not included in API docs #21880

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.

Sign up for GitHub

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

Jump to bottom
Closed
StefRe opened this issue Dec 8, 2021 · 4 comments · Fixed by #23048
Closed

[Doc]: rrulewrapper not included in API docs #21880

StefRe opened this issue Dec 8, 2021 · 4 comments · Fixed by #23048
Labels
Documentation
Milestone
v3.6.0

Comments

@StefRe
Copy link
Contributor

StefRe commented Dec 8, 2021

Documentation Link

https://matplotlib.org/devdocs/api/dates_api.html

Problem

matplotlib/lib/matplotlib/dates.py

Lines 982 to 983 in 2ccc67f

class rrulewrapper:
def __init__(self, freq, tzinfo=None, **kwargs):
has no docstring and hence can't be referred to in the documentation from:

Suggested improvement

Remove the reference

matplotlib/examples/ticks/date_formatters_locators.py

Line 89 in 21ea3fb

# - `matplotlib.dates.rrulewrapper`
or add docstring for rrulewrapper (see #21874 (comment)).

Matplotlib Version

3.6.0.dev910+g505cdff57c
@ghost ghost mentioned this issue Dec 17, 2021
Merged
@ianhi
Copy link
Contributor

ianhi commented Apr 4, 2022

Was this fixed by #21993 ?

@tacaswell
Copy link
Member

Closed by #21993!

@QuLogic QuLogic added this to the v3.6.0 milestone Apr 5, 2022
@StefRe
Copy link
Contributor Author

StefRe commented Apr 5, 2022

@ianhi Actually this wasn't fixed at all, but I'm OK with closing this issue. I already wrote in my comment that PR #21993 pro forma added a docstring but it didn't address the issue #21880 in any way (maybe it's may fault not to have chosen a better title for this issue: the actual issue is that rrulewrapper is not documented in any meaningful way and hence cannot be referenced from examples or the documentation).

@tacaswell tacaswell changed the title [Doc]: rrulewrapper has no docstring [Doc]: rrulewrapper not included in API docs Apr 5, 2022
@tacaswell tacaswell reopened this Apr 5, 2022
@tacaswell
Copy link
Member

I changed the title and re-opened.

@oscargus oscargus mentioned this issue May 14, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging a pull request may close this issue.

Add rrulewrapper to docs oscargus/matplotlib
4 participants
@tacaswell @QuLogic @ianhi @StefRe