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

Jump to bottom

List of PEPs at top of typing docs is too long to be readable #89818

Closed
AlexWaygood opened this issue Oct 28, 2021 · 7 comments
Closed

List of PEPs at top of typing docs is too long to be readable #89818

AlexWaygood opened this issue Oct 28, 2021 · 7 comments
Labels
3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@AlexWaygood
Copy link
Member

BPO 45655
Nosy @gvanrossum, @ambv, @miss-islington, @Fidget-Spinner, @AlexWaygood
PRs
  • bpo-45655: Add "relevant PEPs" section to typing documentation #29280
  • [3.10] bpo-45655: Add "relevant PEPs" section to typing documentation (GH-29280) #29290
  • [3.9] bpo-45655: Add "relevant PEPs" section to typing documentation #29297
  • [3.10] bpo-45655: Add "relevant PEPs" section to typing documentation #29302
  • [3.10] bpo-45655: Add "relevant PEPs" section to typing documentation #29302
  • [3.10] bpo-45655: Add "relevant PEPs" section to typing documentation #29302
  • bpo-45655: Add ref to union-type expressions at top of typing docs #29309
  • [3.10] bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309) #29312
    		•

    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 2021-10-29.10:13:52.298>
created_at = <Date 2021-10-28.18:20:51.270>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = 'List of PEPs at top of typing docs is too long to be readable'
updated_at = <Date 2021-10-29.14:16:27.326>
user = 'https://github.com/AlexWaygood'

    bugs.python.org fields:

    activity = <Date 2021-10-29.14:16:27.326>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-10-29.10:13:52.298>
closer = 'kj'
components = ['Documentation']
creation = <Date 2021-10-28.18:20:51.270>
creator = 'AlexWaygood'
dependencies = []
files = []
hgrepos = []
issue_num = 45655
keywords = ['patch']
message_count = 7.0
messages = ['405215', '405246', '405275', '405299', '405301', '405305', '405306']
nosy_count = 6.0
nosy_names = ['gvanrossum', 'docs@python', 'lukasz.langa', 'miss-islington', 'kj', 'AlexWaygood']
pr_nums = ['29280', '29290', '29297', '29302', '29302', '29302', '29309', '29312']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45655'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
    @AlexWaygood
    Copy link
    Member Author

    The list of relevant PEPs at the top of the typing docs has become too long to be readable or helpful. It would be good if this information could be presented in a more structured way.

    @AlexWaygood AlexWaygood added 3.10 only security fixes 3.11 only security fixes labels Oct 28, 2021
    @AlexWaygood AlexWaygood added docs Documentation in the Doc dir type-feature A feature request or enhancement 3.10 only security fixes 3.11 only security fixes labels Oct 28, 2021
    @AlexWaygood AlexWaygood added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Oct 28, 2021
    @ambv
    Copy link
    Contributor

    ambv commented Oct 28, 2021

    New changeset 03db1bb by Alex Waygood in branch 'main':
    bpo-45655: Add "relevant PEPs" section to typing documentation (GH-29280)
    03db1bb

    @AlexWaygood AlexWaygood added 3.9 only security fixes labels Oct 28, 2021
    @ambv
    Copy link
    Contributor

    ambv commented Oct 28, 2021

    New changeset 8813a98 by Alex Waygood in branch '3.9':
    [3.9] bpo-45655: Add "relevant PEPs" section to typing documentation (GH-29297)
    8813a98

    @Fidget-Spinner
    Copy link
    Member

    Argh, I merged #73488, but messed up the commit title since I'm on mobile. Sorry.

    Currently it says:
    [3.10] bo-45655: Add "relevant PEPs" section to typing documentation (GH-29302)

    It should be:

    [3.10] bpo-45655: Add "relevant PEPs" section to typing documentation
    (GH-29280) (GH-29302)

    I don't think it's big enough of a deal to revert and re-commit. So we're done here. Thanks for your improvements Alex.

    @AlexWaygood
    Copy link
    Member Author

    Thanks, Łukasz and Ken, for reviewing and merging!

    @Fidget-Spinner
    Copy link
    Member

    New changeset d957521 by Alex Waygood in branch 'main':
    bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)
    d957521

    @miss-islington
    Copy link
    Contributor

    New changeset 6742b0d by Miss Islington (bot) in branch '3.10':
    bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)
    6742b0d

    @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
    Assignees
    No one assigned
    Labels
    3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @ambv @Fidget-Spinner @miss-islington @AlexWaygood