Skip to content

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

New issue
New issue
Closed
#23048
Closed
[Doc]: rrulewrapper not included in API docs#21880
#23048
Labels
Documentation
Milestone
v3.6.0

Description

@StefRe
StefRe
opened on 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

Activity

  1. StefRe
    added
    Documentation
    on Dec 8, 2021

  2. ianhi commented on Apr 4, 2022

    @ianhi
    ianhi
    on Apr 4, 2022
    Contributor

    Was this fixed by #21993 ?

  3. tacaswell commented on Apr 4, 2022

    @tacaswell
    tacaswell
    on Apr 4, 2022
    Member

    Closed by #21993!

  4. tacaswell
    closed this as completedon Apr 4, 2022
  5. QuLogic
    added this to the v3.6.0 milestone on Apr 5, 2022

  6. StefRe commented on Apr 5, 2022

    @StefRe
    StefRe
    on Apr 5, 2022
    ContributorAuthor

    @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).

  7. tacaswell
    changed the title [-][Doc]: rrulewrapper has no docstring[/-] [+][Doc]: rrulewrapper not included in API docs[/+] on Apr 5, 2022
  8. tacaswell
    reopened this on Apr 5, 2022

  9. tacaswell commented on Apr 5, 2022

    @tacaswell
    tacaswell
    on Apr 5, 2022
    Member

    I changed the title and re-opened.

  10. jklymak
    closed this as completedin #23048on May 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentation

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions