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

Add docstrings for typing.SupportsXXX classes #82588

Closed
serhiy-storchaka opened this issue Oct 8, 2019 · 4 comments
Closed

Add docstrings for typing.SupportsXXX classes #82588

serhiy-storchaka opened this issue Oct 8, 2019 · 4 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes stdlib Python modules in the Lib dir

Comments

@serhiy-storchaka
Copy link
Member

BPO 38407
Nosy @gvanrossum, @serhiy-storchaka, @ilevkivskyi, @miss-islington
PRs
  • bpo-38407: Add docstrings for typing.SupportsXXX classes. #16644
  • [3.8] bpo-38407: Add docstrings for typing.SupportsXXX classes. (GH-16644) #16656
  • [3.7] bpo-38407: Add docstrings for typing.SupportsXXX classes. (GH-16644). #16673
  • 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 = <Date 2019-10-09.09:58:31.268>
    created_at = <Date 2019-10-08.08:59:44.057>
    labels = ['3.8', '3.7', 'library', '3.9']
    title = 'Add docstrings for typing.SupportsXXX classes'
    updated_at = <Date 2019-10-09.09:58:31.268>
    user = 'https://github.com/serhiy-storchaka'

    bugs.python.org fields:

    activity = <Date 2019-10-09.09:58:31.268>
    actor = 'serhiy.storchaka'
    assignee = 'none'
    closed = True
    closed_date = <Date 2019-10-09.09:58:31.268>
    closer = 'serhiy.storchaka'
    components = ['Library (Lib)']
    creation = <Date 2019-10-08.08:59:44.057>
    creator = 'serhiy.storchaka'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 38407
    keywords = ['patch']
    message_count = 4.0
    messages = ['354179', '354204', '354212', '354261']
    nosy_count = 4.0
    nosy_names = ['gvanrossum', 'serhiy.storchaka', 'levkivskyi', 'miss-islington']
    pr_nums = ['16644', '16656', '16673']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue38407'
    versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

    @serhiy-storchaka
    Copy link
    Member Author

    typing.SupportsXXX classes do not have docstrings and help() shows the docstring of the parent class instead, which is wrong ("Base class for protocol classes...").

    @serhiy-storchaka serhiy-storchaka added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes stdlib Python modules in the Lib dir labels Oct 8, 2019
    @serhiy-storchaka
    Copy link
    Member Author

    New changeset 8252c52 by Serhiy Storchaka in branch 'master':
    bpo-38407: Add docstrings for typing.SupportsXXX classes. (GH-16644)
    8252c52

    @miss-islington
    Copy link
    Contributor

    New changeset 7162440 by Miss Islington (bot) in branch '3.8':
    bpo-38407: Add docstrings for typing.SupportsXXX classes. (GH-16644)
    7162440

    @serhiy-storchaka
    Copy link
    Member Author

    New changeset 0b354fc by Serhiy Storchaka in branch '3.7':
    [3.7] bpo-38407: Add docstrings for typing.SupportsXXX classes. (GH-16644). (GH-16673)
    0b354fc

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes stdlib Python modules in the Lib dir
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants