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

Documentation for @singledispatch and @singledispatchmethod could be improved #89889

Closed
AlexWaygood opened this issue Nov 5, 2021 · 3 comments
Closed

Documentation for @singledispatch and @singledispatchmethod could be improved #89889

AlexWaygood opened this issue Nov 5, 2021 · 3 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 45726
Nosy @rhettinger, @ambv, @miss-islington, @AlexWaygood
PRs
  • bpo-45726: Improve docs for @singledispatch/@singledispatchmethod #29426
  • [3.9] bpo-45726: Improve docs for @singledispatch/@singledispatchmethod (GH-29426) #29430
  • [3.10] bpo-45726: Improve docs for @singledispatch/@singledispatchmethod (GH-29426) #29431
    		•

    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-11-05.16:53:22.938>
created_at = <Date 2021-11-05.12:15:07.924>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = 'Documentation for `@singledispatch` and `@singledispatchmethod` could be improved'
updated_at = <Date 2021-11-05.16:54:34.824>
user = 'https://github.com/AlexWaygood'

    bugs.python.org fields:

    activity = <Date 2021-11-05.16:54:34.824>
actor = 'AlexWaygood'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-11-05.16:53:22.938>
closer = 'lukasz.langa'
components = ['Documentation']
creation = <Date 2021-11-05.12:15:07.924>
creator = 'AlexWaygood'
dependencies = []
files = []
hgrepos = []
issue_num = 45726
keywords = ['patch']
message_count = 3.0
messages = ['405788', '405809', '405810']
nosy_count = 5.0
nosy_names = ['rhettinger', 'docs@python', 'lukasz.langa', 'miss-islington', 'AlexWaygood']
pr_nums = ['29426', '29430', '29431']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45726'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
    @AlexWaygood
    Copy link
    Member Author

    The documentation for functools.singledispatch and functools.singledispatchmethod contains a few small grammar mistakes and instances of slightly inelegant writing. PR to follow shortly.

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

    ambv commented Nov 5, 2021

    Thanks, Alex! ✨ 🍰 ✨

    I'm not a native speaker so your review of my language use was helpful 🤓

    @ambv ambv closed this as completed Nov 5, 2021
    @ambv ambv closed this as completed Nov 5, 2021
    @AlexWaygood
    Copy link
    Member Author

    Thanks for reviewing and merging, Łukasz -- appreciate it!

    @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
    2 participants
    @ambv @AlexWaygood