Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Improve typing.py docstrings #105286

Closed
AlexWaygood opened this issue Jun 4, 2023 · 0 comments · Fixed by #105322
Closed

Improve typing.py docstrings #105286

AlexWaygood opened this issue Jun 4, 2023 · 0 comments · Fixed by #105322
Assignees
@AlexWaygood
Labels
topic-typing

Comments

@AlexWaygood
Copy link
Member

AlexWaygood commented Jun 4, 2023 •
edited by bedevere-bot
Loading

The docstrings in typing.py could do with a spring clean. As well as several small grammatical errors, there's also several details which are out of date; very inconsistent indentation in code examples; and numerous other small things that could be improved.

Linked PRs
@AlexWaygood AlexWaygood self-assigned this Jun 4, 2023
@bedevere-bot bedevere-bot mentioned this issue Jun 4, 2023
Merged
AlexWaygood added a commit that referenced this issue Jun 5, 2023
@AlexWaygood @hauntsaninja @sobolevn
gh-105286: Improve typing.py docstrings (#105287)
f714aa2 
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Jun 5, 2023
@AlexWaygood @hauntsaninja @sobolevn
pythongh-105286: Improve typing.py docstrings (python#105287)
e4b6cb7 
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@bedevere-bot bedevere-bot mentioned this issue Jun 5, 2023
Merged
AlexWaygood added a commit that referenced this issue Jun 5, 2023
@AlexWaygood @hauntsaninja @sobolevn
[3.12] gh-105286: Improve typing.py docstrings (#105287) (#105319)
83fc562 
gh-105286: Improve `typing.py` docstrings (#105287)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@AlexWaygood AlexWaygood mentioned this issue Jun 5, 2023
Merged
@AlexWaygood AlexWaygood linked a pull request Jun 5, 2023 that will close this issue
[3.11] gh-105286: Improve typing.py docstrings (#105287) #105322
Merged
AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Jun 5, 2023
@AlexWaygood @hauntsaninja @sobolevn
[3.11] pythongh-105286: Improve typing.py docstrings (python#105287)
4b28281 
pythongh-105286: Improve `typing.py` docstrings (python#105287)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
ambv pushed a commit that referenced this issue Jun 5, 2023
@AlexWaygood @hauntsaninja @sobolevn
[3.11] gh-105286: Improve typing.py docstrings (#105287) (#105322)
93d9e99 
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@erlend-aasland erlend-aasland mentioned this issue Jun 6, 2023
Closed
AlexWaygood added a commit to AlexWaygood/cpython that referenced this issue Jun 6, 2023
@AlexWaygood
pythongh-105286: Further improvements to typing.py docstrings
aa90be8
@bedevere-bot bedevere-bot mentioned this issue Jun 6, 2023
Merged
JelleZijlstra pushed a commit that referenced this issue Jun 7, 2023
@AlexWaygood
gh-105286: Further improvements to typing.py docstrings (#105363)
9a89f1b
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 7, 2023
@AlexWaygood @miss-islington
pythongh-105286: Further improvements to typing.py docstrings (pyth…
cedc709 
…onGH-105363)

(cherry picked from commit 9a89f1b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot bedevere-bot mentioned this issue Jun 7, 2023
Merged
JelleZijlstra pushed a commit to JelleZijlstra/cpython that referenced this issue Jun 7, 2023
@AlexWaygood @JelleZijlstra
[3.11] pythongh-105286: Further improvements to typing.py docstrings (
07a6713 
pythonGH-105363).

(cherry picked from commit 9a89f1b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot bedevere-bot mentioned this issue Jun 7, 2023
Merged
JelleZijlstra pushed a commit that referenced this issue Jun 7, 2023
@miss-islington @AlexWaygood
[3.12] gh-105286: Further improvements to typing.py docstrings (GH-…
84133c5 
…105363) (#105416)

gh-105286: Further improvements to `typing.py` docstrings (GH-105363)
(cherry picked from commit 9a89f1b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this issue Jun 7, 2023
@JelleZijlstra @AlexWaygood
[3.11] gh-105286: Further improvements to typing.py docstrings (GH-…
3a195f3 
…105363) (#105417)

[3.11] gh-105286: Further improvements to `typing.py` docstrings (GH-105363).
(cherry picked from commit 9a89f1b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@AlexWaygood AlexWaygood

Labels
topic-typing
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[3.11] gh-105286: Improve typing.py docstrings (#105287) AlexWaygood/cpython
1 participant
@AlexWaygood