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

types.GenericAlias and types.Union have no documentation #85971

Closed
pxeger mannequin opened this issue Sep 17, 2020 · 9 comments
Closed

types.GenericAlias and types.Union have no documentation #85971

pxeger mannequin opened this issue Sep 17, 2020 · 9 comments
Labels
3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir

Comments

@pxeger
Copy link
Mannequin

pxeger mannequin commented Sep 17, 2020

BPO 41805
Nosy @gvanrossum, @andresdelfino, @miss-islington, @pxeger, @Fidget-Spinner
PRs
  • bpo-41805: Documentation for PEP 585 #22615
  • [3.9] bpo-41805: Documentation for PEP 585 (GH-22615) #23016
  • 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 2020-10-28.15:59:14.723>
    created_at = <Date 2020-09-17.19:28:27.986>
    labels = ['3.9', '3.10', 'docs']
    title = 'types.GenericAlias and types.Union have no documentation'
    updated_at = <Date 2020-10-28.16:13:11.948>
    user = 'https://github.com/pxeger'

    bugs.python.org fields:

    activity = <Date 2020-10-28.16:13:11.948>
    actor = 'gvanrossum'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2020-10-28.15:59:14.723>
    closer = 'gvanrossum'
    components = ['Documentation']
    creation = <Date 2020-09-17.19:28:27.986>
    creator = 'pxeger'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 41805
    keywords = ['patch']
    message_count = 9.0
    messages = ['377064', '377072', '378040', '378282', '379806', '379830', '379832', '379835', '379836']
    nosy_count = 6.0
    nosy_names = ['gvanrossum', 'docs@python', 'adelfino', 'miss-islington', 'pxeger', 'kj']
    pr_nums = ['22615', '23016']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue41805'
    versions = ['Python 3.9', 'Python 3.10']

    @pxeger
    Copy link
    Mannequin Author

    pxeger mannequin commented Sep 17, 2020

    See title.

    For reference:

    GenericAlias was added by Guido van Rossum guido@python.org in commit 48b069a "bpo-39481: Implementation for PEP-585 (bpo-18239)"

    Union was added by Maggi Moss MaggieMoss@users.noreply.github.com in commit 1b4552c "bpo-41428: Implementation for PEP-604 (GH-21515)"

    I can do a PR which would need backporting (is that the right word?) to 3.9 at least for GenericAlias.

    @pxeger pxeger mannequin added 3.9 only security fixes 3.10 only security fixes labels Sep 17, 2020
    @pxeger pxeger mannequin assigned docspython Sep 17, 2020
    @pxeger pxeger mannequin added docs Documentation in the Doc dir 3.9 only security fixes 3.10 only security fixes labels Sep 17, 2020
    @pxeger pxeger mannequin assigned docspython Sep 17, 2020
    @pxeger pxeger mannequin added the docs Documentation in the Doc dir label Sep 17, 2020
    @andresdelfino
    Copy link
    Contributor

    Hi, Patrick! Yes! It would be great if you could open a PR to document those new types.

    The documentation of types.Union should go to master only, and the documentation of types.GenericAlias to both master and 3.9, so two PRs should me opened to address this issues separately.

    The backporting (yes! that's the word) to 3.9 will be (fingers-crossed) automatic thanks to Mariatta's https://github.com/python/miss-islington

    @Fidget-Spinner
    Copy link
    Member

    Hi Patrick, I've completed the docs for PEP-604, and would like to work on the docs for PEP-585. May I know if you're still working on this?

    @pxeger
    Copy link
    Mannequin Author

    pxeger mannequin commented Oct 8, 2020

    Sorry, I'd completely forgotten about doing a PR for this. Go ahead!

    @gvanrossum
    Copy link
    Member

    New changeset 4173320 by kj in branch 'master':
    bpo-41805: Documentation for PEP-585 (GH-22615)
    4173320

    @miss-islington
    Copy link
    Contributor

    New changeset 577d7c4 by kj in branch '3.9':
    [3.9] bpo-41805: Documentation for PEP-585 (GH-22615) (GH-23016)
    577d7c4

    @gvanrossum
    Copy link
    Member

    Thanks Ken Ji! Are you planning more doc patches?

    @Fidget-Spinner
    Copy link
    Member

    @guido, you're welcome! I'm thinking of updating the temporary hyperlinks for GenericAlias/PEP 585 in Union, subscriptions and typing, I'll submit 2 separate PRs since subscription and typing require backporting.

    If I think of anything major, I'll open a separate bpo to keep track of it there. Thanks.

    @gvanrossum
    Copy link
    Member

    Cool. Please add me to the nosy list of any issues you open.

    Also, if you're interesting helping out with the match statement, once the SC approves it, we'll need to add docs for that. See bpo-42128 for a possible plan.

    @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.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    4 participants