Skip to content

Fix typos in docs and comments #109619

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

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Fix typos in docs and comments #109619

merged 1 commit into from
Sep 20, 2023

Conversation

afuetterer
Copy link
Contributor

@afuetterer afuetterer commented Sep 20, 2023

Proposed changes

Hi, this is my first PR to the project. Please feel free to close if unwanted. As per the pull request template I did not open an issue first, because this PR only fixes typos.

I found a few occurrences of "the the" and a few minor typos in the docs.

Are these alright?

Thank you. :)


📚 Documentation preview 📚: https://cpython-previews--109619.org.readthedocs.build/

@ghost
Copy link

ghost commented Sep 20, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@gvanrossum gvanrossum removed their request for review September 20, 2023 16:34
@AlexWaygood AlexWaygood changed the title chore: fix typos Fix typos in docs and comments Sep 20, 2023
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Sep 20, 2023
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks! FWIW, while typo fixes in docs files are valuable, we try to discourage PRs just making typo fixes to comments etc. — that kind of PR doesn't change the behavior of the code at all, and tends to just lead to unnecessary code churn. It'll also make this PR harder to backport. Since you've already gone ahead and corrected these typos, however, I'm happy for this PR to be merged as-is :-)

@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry, @afuetterer 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 ef6d475db3af4d30a3104fa6301dcd36c71eacab 3.12

@miss-islington
Copy link
Contributor

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

@bedevere-app
Copy link

bedevere-app bot commented Sep 20, 2023

GH-109621 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 Sep 20, 2023
AlexWaygood pushed a commit to AlexWaygood/cpython that referenced this pull request Sep 20, 2023
@bedevere-bot

This comment was marked as off-topic.

AlexWaygood pushed a commit to AlexWaygood/cpython that referenced this pull request Sep 20, 2023
@bedevere-app
Copy link

bedevere-app bot commented Sep 20, 2023

GH-109622 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Sep 20, 2023
@bedevere-bot

This comment was marked as off-topic.

AlexWaygood added a commit that referenced this pull request Sep 20, 2023
@bedevere-bot

This comment was marked as off-topic.

@bedevere-bot

This comment was marked as off-topic.

@afuetterer afuetterer deleted the fix-typos branch September 21, 2023 04:25
@afuetterer
Copy link
Contributor Author

Thanks! FWIW, while typo fixes in docs files are valuable, we try to discourage PRs just making typo fixes to comments etc. — that kind of PR doesn't change the behavior of the code at all, and tends to just lead to unnecessary code churn. It'll also make this PR harder to backport. Since you've already gone ahead and corrected these typos, however, I'm happy for this PR to be merged as-is :-)

Thank you for explaining, I will look out for other typos in the docs in the future, but not look at comments again.

csm10495 pushed a commit to csm10495/cpython that referenced this pull request Sep 28, 2023
Yhg1s pushed a commit that referenced this pull request Oct 2, 2023
Fix typos in docs and comments (#109619)

Co-authored-by: Heinz-Alexander Fuetterer <[email protected]>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
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