Skip to content
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

pydoc skips methods of nested classes #85799

Open
bkline mannequin opened this issue Aug 25, 2020 · 2 comments
Open

pydoc skips methods of nested classes #85799

bkline mannequin opened this issue Aug 25, 2020 · 2 comments
Assignees
Labels
3.13 new features, bugs and security fixes stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error

Comments

@bkline
Copy link
Mannequin

bkline mannequin commented Aug 25, 2020

BPO 41633
Nosy @bkline
Files
  • repro.py: Repro case to illustrate behavior
  • Screen Shot 2020-08-25 at 11.26.39 AM.png
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = None
    created_at = <Date 2020-08-25.15:28:26.817>
    labels = ['3.8', 'type-bug', 'library']
    title = 'pydoc skips methods of nested classes'
    updated_at = <Date 2020-08-25.15:30:09.114>
    user = 'https://github.com/bkline'

    bugs.python.org fields:

    activity = <Date 2020-08-25.15:30:09.114>
    actor = 'bkline'
    assignee = 'none'
    closed = False
    closed_date = None
    closer = None
    components = ['Library (Lib)']
    creation = <Date 2020-08-25.15:28:26.817>
    creator = 'bkline'
    dependencies = []
    files = ['49428', '49429']
    hgrepos = []
    issue_num = 41633
    keywords = []
    message_count = 2.0
    messages = ['375891', '375892']
    nosy_count = 1.0
    nosy_names = ['bkline']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue41633'
    versions = ['Python 3.8']

    @bkline
    Copy link
    Mannequin Author

    bkline mannequin commented Aug 25, 2020

    Although the documentation for the pydoc says that it produces documentation of the classes recursively, this isn't actually true.

    @bkline bkline mannequin added 3.8 only security fixes stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error labels Aug 25, 2020
    @bkline
    Copy link
    Mannequin Author

    bkline mannequin commented Aug 25, 2020

    Here is the generated documentation. Note that no mention is made of the inner class's method.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @serhiy-storchaka serhiy-storchaka self-assigned this Dec 12, 2023
    @serhiy-storchaka serhiy-storchaka added 3.13 new features, bugs and security fixes and removed 3.8 only security fixes labels Dec 12, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.13 new features, bugs and security fixes stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant