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

Improve documentation for typing._GenericAlias #90747

Closed
mrahtz mannequin opened this issue Jan 30, 2022 · 3 comments
Closed

Improve documentation for typing._GenericAlias #90747

mrahtz mannequin opened this issue Jan 30, 2022 · 3 comments
Labels
3.11 only security fixes docs Documentation in the Doc dir stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@mrahtz
Copy link
Mannequin

mrahtz mannequin commented Jan 30, 2022

BPO 46589
Nosy @gvanrossum, @JelleZijlstra, @Fidget-Spinner, @mrahtz
PRs
  • bpo-46589: Improve documentation for typing._GenericAlias #31026
  • 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 2022-01-30.19:55:28.395>
    labels = ['3.11', 'type-feature', 'library', 'docs']
    title = 'Improve documentation for typing._GenericAlias'
    updated_at = <Date 2022-02-07.01:59:39.743>
    user = 'https://github.com/mrahtz'

    bugs.python.org fields:

    activity = <Date 2022-02-07.01:59:39.743>
    actor = 'gvanrossum'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation', 'Library (Lib)']
    creation = <Date 2022-01-30.19:55:28.395>
    creator = 'matthew.rahtz'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 46589
    keywords = ['patch']
    message_count = 2.0
    messages = ['412171', '412703']
    nosy_count = 5.0
    nosy_names = ['gvanrossum', 'docs@python', 'JelleZijlstra', 'kj', 'matthew.rahtz']
    pr_nums = ['31026']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue46589'
    versions = ['Python 3.11']

    @mrahtz
    Copy link
    Mannequin Author

    mrahtz mannequin commented Jan 30, 2022

    There's currently not much documentation in typing.py for _GenericAlias. Some fairly weird things go on in there, so it would be great to have more info in the class about what's going on and why various edge cases are necessary.

    @mrahtz mrahtz mannequin added 3.11 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement labels Jan 30, 2022
    @AlexWaygood AlexWaygood added the docs Documentation in the Doc dir label Jan 30, 2022
    @AlexWaygood AlexWaygood added the docs Documentation in the Doc dir label Jan 30, 2022
    @gvanrossum
    Copy link
    Member

    New changeset a335d98 by Matthew Rahtz in branch 'main':
    bpo-46589: Improve documentation for typing._GenericAlias (GH-31026)
    a335d98

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @JelleZijlstra
    Copy link
    Member

    Closing since #31026 was merged (cc @mrahtz).

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.11 only security fixes docs Documentation in the Doc dir stdlib Python modules in the Lib dir type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    3 participants