Skip to content

Fix typos in docs, error messages and comments#122502

Merged
AlexWaygood merged 1 commit into
python:mainfrom
jianghuyiyuan:main
Aug 1, 2024
Merged

Fix typos in docs, error messages and comments#122502
AlexWaygood merged 1 commit into
python:mainfrom
jianghuyiyuan:main

Conversation

@jianghuyiyuan
Copy link
Copy Markdown
Contributor

@jianghuyiyuan jianghuyiyuan commented Jul 31, 2024

Signed-off-by: jianghuyiyuan <shuangcui@live.com>
@ghost
Copy link
Copy Markdown

ghost commented Jul 31, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jul 31, 2024

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@erlend-aasland
Copy link
Copy Markdown
Contributor

Thanks, but I think we can manage with these minor inconsistencies in the comments.

@AlexWaygood
Copy link
Copy Markdown
Member

This PR touches six files. Of the six files touched, three of the files are docs files, in which the PR fixes grammatical errors in the docs, and in a fourth file the PR fixes a spelling error in a message that could be shown to a user.

I agree with @erlend-aasland that we don't want to encourage PRs that only fix typos in comments, but — despite its current title — that's not what this PR does. I think overall the changes this PR makes are valuable.

@AlexWaygood AlexWaygood reopened this Jul 31, 2024
@AlexWaygood AlexWaygood changed the title chore: fix some comments Fix typos in docs, error messages and comments Jul 31, 2024
@AlexWaygood AlexWaygood added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jul 31, 2024
@AlexWaygood AlexWaygood enabled auto-merge (squash) July 31, 2024 23:39
@AlexWaygood AlexWaygood self-assigned this Jul 31, 2024
@AlexWaygood AlexWaygood merged commit 46f5a4f into python:main Aug 1, 2024
@miss-islington-app
Copy link
Copy Markdown

Thanks @jianghuyiyuan for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link
Copy Markdown

Sorry, @jianghuyiyuan and @AlexWaygood, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 46f5a4f9e1781ad8d60eb53bbaf6cd8534a286cd 3.13

@miss-islington-app
Copy link
Copy Markdown

Sorry, @jianghuyiyuan and @AlexWaygood, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 46f5a4f9e1781ad8d60eb53bbaf6cd8534a286cd 3.12

@erlend-aasland
Copy link
Copy Markdown
Contributor

and in a fourth file the PR fixes a spelling error in a message that could be shown to a user

More specific a user who builds a debug build of CPython; the error message is guarded by the debug flag.

@picnixz
Copy link
Copy Markdown
Member

picnixz commented Aug 1, 2024

Actually, we had a bunch of similar PRs that were accepted those past weeks (even when touching the C code) so I think we should have allowed this one as well: https://github.com/python/cpython/pulls?q=is%3Apr+author%3Axyb+sort%3Aupdated-desc (those are the PRs I rememebered)

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Aug 2, 2024

GH-122605 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Aug 2, 2024
AlexWaygood pushed a commit to AlexWaygood/cpython that referenced this pull request Aug 2, 2024
(cherry-picked from commit 46f5a4f)

Signed-off-by: jianghuyiyuan <shuangcui@live.com>
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Aug 2, 2024

GH-122606 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 2, 2024
AlexWaygood pushed a commit to AlexWaygood/cpython that referenced this pull request Aug 2, 2024
(cherry-picked from commit 46f5a4f)

Signed-off-by: jianghuyiyuan <shuangcui@live.com>
AlexWaygood added a commit that referenced this pull request Aug 2, 2024
Co-authored-by: jianghuyiyuan <shuangcui@live.com>
Fix typos in docs, error messages and comments (#122502)
blhsing pushed a commit to blhsing/cpython that referenced this pull request Aug 22, 2024
Signed-off-by: jianghuyiyuan <shuangcui@live.com>
Yhg1s pushed a commit that referenced this pull request Sep 2, 2024
)

Fix typos in docs, error messages and comments (#122502)

(cherry-picked from commit 46f5a4f)

Signed-off-by: jianghuyiyuan <shuangcui@live.com>
Co-authored-by: jianghuyiyuan <shuangcui@live.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants