Skip to content

pydoc skips methods of nested classes #85799

Open

Description

@bkline
mannequin
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']

    Activity

    1. bkline commented on Aug 25, 2020

      bklinemannequin
      MannequinAuthor

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

    2. added
      stdlibStandard Library Python modules in the Lib/ directory
      type-bugAn unexpected behavior, bug, or error
      on Aug 25, 2020
    3. bkline commented on Aug 25, 2020

      bklinemannequin
      MannequinAuthor

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

    4. transferred this issue fromon Apr 10, 2022
    5. added
      3.13only security fixes
      and removed on Dec 12, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Labels

    3.13only security fixesstdlibStandard Library Python modules in the Lib/ directorytype-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions