Skip to content

bpo-40745: Fix typos in NewType docs #20379

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.

Sign up for GitHub

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
Merged
merged 2 commits into from
May 26, 2020
Merged

bpo-40745: Fix typos in NewType docs #20379

merged 2 commits into from
May 26, 2020

Conversation

zihengCat
Copy link
Contributor

@zihengCat zihengCat commented May 25, 2020 •
edited by miss-islington
Loading

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 25, 2020
csabella
csabella requested changes May 25, 2020
View reviewed changes
Doc/library/typing.rst Outdated
@@ -1023,7 +1023,7 @@ The module defines the following classes, functions and decorators:

.. function:: NewType(typ)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the function signature for NewType doesn't match the examples since they call it with two parameters, but there's only one here. Can you also add that in this patch? Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! @csabella

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And thanks @csabella for your keen eye!

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

gvanrossum
gvanrossum approved these changes May 25, 2020
View reviewed changes
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG. Why did you change ‘typ’ to ‘tp’?

@gvanrossum gvanrossum changed the title bpo-40745: fix a small typo in library/typing .rst doc bpo-40745: Fix typos in NewType docs May 25, 2020
@zihengCat
Copy link
Contributor Author

LG. Why did you change ‘typ’ to ‘tp’?

@gvanrossum

Screen Shot 2020-05-26 at 10 31 25

@miss-islington miss-islington merged commit 2b0e654 into python:master May 26, 2020
@miss-islington
Copy link
Contributor

Thanks @zihengCat for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 26, 2020
@zihengCat @miss-islington
bpo-40745: Fix typos in NewType docs (pythonGH-20379)
83e969e 
(cherry picked from commit 2b0e654)

Co-authored-by: ziheng <[email protected]>
@bedevere-bot
Copy link

GH-20410 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label May 26, 2020
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 26, 2020
@zihengCat @miss-islington
bpo-40745: Fix typos in NewType docs (pythonGH-20379)
8ca5c84 
(cherry picked from commit 2b0e654)

Co-authored-by: ziheng <[email protected]>
@bedevere-bot
Copy link

GH-20411 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request May 26, 2020
@miss-islington @zihengCat
bpo-40745: Fix typos in NewType docs (GH-20379)
6597e2a 
(cherry picked from commit 2b0e654)

Co-authored-by: ziheng <[email protected]>
miss-islington added a commit that referenced this pull request May 26, 2020
@miss-islington @zihengCat
bpo-40745: Fix typos in NewType docs (GH-20379)
b38bd88 
(cherry picked from commit 2b0e654)

Co-authored-by: ziheng <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gvanrossum gvanrossum gvanrossum approved these changes

@csabella csabella csabella requested changes

@remilapeyre remilapeyre remilapeyre approved these changes

@ilevkivskyi ilevkivskyi Awaiting requested review from ilevkivskyi

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@zihengCat @bedevere-bot @miss-islington @gvanrossum @csabella @remilapeyre @the-knights-who-say-ni