Fix typos in docs, comments and test assert messages #14872

minho42 · 2019-07-21T01:35:07Z

No description provided.

aeros

@minho42 Thanks for the contribution! I've seen quite a number of PRs which fix typos, but I've yet to see one involving 22 different files at once. Nicely done.

I approve of all of the typo fixes, but I noticed a few which could use some minor improvements.

Doc/library/ctypes.rst

Lib/test/support/__init__.py

Lib/test/test_dataclasses.py

Lib/test/test_importlib/test_main.py

terryjreedy

I have verified that all but 1 of the corrections is correct and that that 1 is corrected in the comment. That should be enough review of the corrections themselves. I approve of this given that one correction. I consider the one wording change I approved of to be optional.

'minho': I am willing to merge this, but I first need to know if you intend to fix up the merge conflicts I expect if we try to backport to 3.8, or 3.7. I expect that at least one misspelling is new in master.

Co-Authored-By: Kyle Stanley <aeros167@gmail.com>

minho42 · 2019-07-21T08:42:33Z

@terryjreedy
Are you able to merge this?
Does that mean you are going to fix the merge conflicts?

I'd like to resolve the merge conflicts myself but I won't be able to use my laptop for the next few days.

minho42 · 2019-07-21T08:46:34Z

@aeros167
Thanks for the suggestions.

aeros · 2019-07-21T08:51:10Z

@minho42

Are you able to merge this?
Does that mean you are going to fix the merge conflicts?

Unless I'm misunderstanding what terry said, the merge conflicts only need to be resolved if he adds the backport labels so that these changes are included in the 3.8 and 3.7 docs. If it's only merged into 3.9 without a backport, the merge conflicts shouldn't be an issue.

If all of the deployment tests are passing and there's no indication otherwise, this should be able to get auto-merged into 3.9 without issues.

aeros · 2019-07-21T08:55:22Z

@minho42 Undo the following commit:
d91fb72

(based on the review from eric)

minho42 · 2019-07-21T08:56:57Z

@aeros167
Then I'm happy to let this merged into 3.9 without backporting!

minho42 · 2019-07-21T09:16:00Z

@aeros167
Changed back.

terryjreedy

Two doc build tests failed with what seems like a false positive

Warning, treated as error:
[distutils/examples:267] "`" found in "This is the description of the ``foobar`` package."

This makes no sense to me because this PR does not touch this doc and because I think the backticks are normal and not an error or even 'suspcious'.

I moved the idlelib fix to a separate PR, #14879, to make sure it gets immediately backported. I keep help.py synchronized across active versions. This change will trigger a test there and a retest here.

bedevere-bot · 2019-07-21T20:12:36Z

@terryjreedy: Please replace # with GH- in the commit message next time. Thanks!

miss-islington · 2019-07-21T20:19:59Z

Thanks @minho42 for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington · 2019-07-21T20:20:04Z

Sorry, @minho42 and @terryjreedy, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 96e12d5f4f3c5a20986566038ee763dff3c228a1 3.8

terryjreedy · 2019-07-21T20:22:29Z

Thank you for the corrections. I was correct that backport would need fixup. I am done with this unless one of you wants to do them.

aeros · 2019-07-21T21:24:35Z

@terryjreedy I wouldn't mind trying to help work through the merge conflicts, but I don't think there's way for me to directly edit the PR.

terryjreedy · 2019-07-21T22:06:41Z

Right, you prepare a new pr, much as the bot does, using the cherry_picker app on pypi, with the command line given above, except that you continue where the bot quit. To install for recent python,
python -m pip install cherry_picker
There may be some doc on the site. Or
python -m cherry_picker -h
for help. (I use python - m because cherry_picker -h may or may not work, depending on your install.)
It should be educational, and more requiring of attention to detail than really hard. This should be a good pr to practice with.

You can use git cherry-pick directly, instead, but cherry_picker will do the routine parts, including pushing to github and making a PR.

minho42 · 2019-07-21T23:15:42Z

Thanks @aeros167 @terryjreedy

aeros · 2019-07-22T00:17:39Z

@terryjreedy Sounds good, I'll give it a try then. I'm interested in the new GitHub triager role, so it would be good to learn how to manually (with cherry_picker) backport and reserve merge conflicts.

When opening the new PR, I should name it something using a similar format to the PR you did, but with 3.8 in brackets?:
[3.8] Fix typos found by Min Ho Kim

Also, I'm assuming that I should specifically direct the PR at the branch python:3.8 instead of the usual python:master. Apologies if any of this is fairly obvious, I'm not as familiar with the manual back porting process. I'll make a comment in here linking to it when it's ready.

Edit: The naming and branch to point at was assuming the manual process with git cherry-pick in case the automatic process has any issues. I'll try to do it w/ cherry_picker first.

…14872). (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

bedevere-bot · 2019-07-22T01:50:29Z

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

aeros · 2019-07-22T02:10:54Z

I was able to resolve the conflicts and create the backport with cherry_picker. It looks like all of the tests are passing, let me know if there's any issues: #14900. Should I attempt to do to the same for 3.7 as well?

#14900) (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

terryjreedy · 2019-07-22T03:08:58Z

In response to cherry_picker 96e12d5f4f3c5a20986566038ee763dff3c228a1 3.8, cherry_picker checks out permanent branch 3.8, creates (checkout -b) a branch based on that (of whatever name, not important), and then applies the indicated commit diff. If there are no merge conflicts, it proceeds. Otherwise it stops and tells you to fix them. It copies the original title and adds [3.8] (in this case). When you tell it to continue, it commits with the original message and adds the boilerplate. You saw what you got.

To do 3.7, change 3.8 to 3.7 and leave the commit-to-master hash as is. The conventions here is that all backports are from the original commit to master. A git expert (not me ;-) could fake it by manually applying the (in this case) reduced 3.8 diff, fixing any additional conflicts, and then adding the comment

Original PR: #14900 
(cherry picked from commit 96e12d5)

as long as the result was the same as if that were done.

These occasional typo fixes are about the only PRs with such increasing conflicts.

…14872). (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

aeros · 2019-07-22T06:25:23Z

Created backport for 3.7: GH-14901. There were significantly more conflicts with this one, and several of the sections that changes were made to did not exist in 3.7.

#14901) (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

Fix typos

80006e5

minho42 requested review from 1st1, asvetlov, ericvsmith, rhettinger, terryjreedy and a team as code owners July 21, 2019 01:35

the-knights-who-say-ni added the CLA signed label Jul 21, 2019

bedevere-bot added the awaiting review label Jul 21, 2019

Fix typo in doc

cd47f18

aeros approved these changes Jul 21, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Jul 21, 2019

terryjreedy reviewed Jul 21, 2019

View reviewed changes

terryjreedy added skip issue skip news labels Jul 21, 2019

minho42 and others added 3 commits July 21, 2019 18:11

Update Lib/test/support/__init__.py

48dfdea

Co-Authored-By: Kyle Stanley <aeros167@gmail.com>

Update Lib/test/test_dataclasses.py

d91fb72

Co-Authored-By: Kyle Stanley <aeros167@gmail.com>

Update Lib/test/test_importlib/test_main.py

0f57970

Co-Authored-By: Kyle Stanley <aeros167@gmail.com>

Revert applied suggestion

5eb91c3

Revert change in idlelib/help.py; fix separately.

b6b3b3d

terryjreedy approved these changes Jul 21, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Jul 21, 2019

terryjreedy closed this Jul 21, 2019

terryjreedy reopened this Jul 21, 2019

terryjreedy merged commit 96e12d5 into python:master Jul 21, 2019

bedevere-bot removed the awaiting merge label Jul 21, 2019

terryjreedy added the needs backport to 3.8 label Jul 21, 2019

miss-islington assigned terryjreedy Jul 21, 2019

aeros pushed a commit to aeros/cpython that referenced this pull request Jul 22, 2019

[3.8] Fix typos in docs, comments and test assert messages (pythonGH-…

a6a0aa5

…14872). (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

aeros mentioned this pull request Jul 22, 2019

[3.8] Fix typos in docs, comments and test assert messages (GH-14872). #14900

Merged

bedevere-bot removed the needs backport to 3.8 label Jul 22, 2019

terryjreedy pushed a commit that referenced this pull request Jul 22, 2019

[3.8] Fix typos in docs, comments and test assert messages (GH-14872). (

24b5b36

#14900) (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

aeros pushed a commit to aeros/cpython that referenced this pull request Jul 22, 2019

[3.7] Fix typos in docs, comments and test assert messages (pythonGH-…

5a01532

…14872). (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

aeros mentioned this pull request Jul 22, 2019

[3.7] Fix typos in docs, comments and test assert messages (GH-14872). #14901

Merged

terryjreedy pushed a commit that referenced this pull request Jul 22, 2019

[3.7] Fix typos in docs, comments and test assert messages (GH-14872). (

83cec02

#14901) (cherry picked from commit 96e12d5) Co-authored-by: Min ho Kim <minho42@gmail.com>

lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019

Fix typos in docs, comments and test assert messages (python#14872)

6fd3ce7

DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020

Fix typos in docs, comments and test assert messages (python#14872)

83854f7

websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020

Fix typos in docs, comments and test assert messages (python#14872)

172a4b1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix typos in docs, comments and test assert messages #14872

Fix typos in docs, comments and test assert messages #14872

minho42 commented Jul 21, 2019

aeros left a comment

terryjreedy left a comment

minho42 commented Jul 21, 2019

minho42 commented Jul 21, 2019

aeros commented Jul 21, 2019

aeros commented Jul 21, 2019 •

edited

Loading

minho42 commented Jul 21, 2019

minho42 commented Jul 21, 2019

terryjreedy left a comment

bedevere-bot commented Jul 21, 2019

miss-islington commented Jul 21, 2019

miss-islington commented Jul 21, 2019

terryjreedy commented Jul 21, 2019

aeros commented Jul 21, 2019

terryjreedy commented Jul 21, 2019

minho42 commented Jul 21, 2019

aeros commented Jul 22, 2019 •

edited

Loading

bedevere-bot commented Jul 22, 2019

aeros commented Jul 22, 2019

terryjreedy commented Jul 22, 2019

aeros commented Jul 22, 2019

Fix typos in docs, comments and test assert messages #14872

Fix typos in docs, comments and test assert messages #14872

Conversation

minho42 commented Jul 21, 2019

aeros left a comment

Choose a reason for hiding this comment

terryjreedy left a comment

Choose a reason for hiding this comment

minho42 commented Jul 21, 2019

minho42 commented Jul 21, 2019

aeros commented Jul 21, 2019

aeros commented Jul 21, 2019 • edited Loading

minho42 commented Jul 21, 2019

minho42 commented Jul 21, 2019

terryjreedy left a comment

Choose a reason for hiding this comment

bedevere-bot commented Jul 21, 2019

miss-islington commented Jul 21, 2019

miss-islington commented Jul 21, 2019

terryjreedy commented Jul 21, 2019

aeros commented Jul 21, 2019

terryjreedy commented Jul 21, 2019

minho42 commented Jul 21, 2019

aeros commented Jul 22, 2019 • edited Loading

bedevere-bot commented Jul 22, 2019

aeros commented Jul 22, 2019

terryjreedy commented Jul 22, 2019

aeros commented Jul 22, 2019

aeros commented Jul 21, 2019 •

edited

Loading

aeros commented Jul 22, 2019 •

edited

Loading