Skip to content
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

Fix typos #125473

Closed
wants to merge 1 commit into from
Closed

Fix typos #125473

wants to merge 1 commit into from

Conversation

ember91
Copy link
Contributor

@ember91 ember91 commented Oct 14, 2024

This has two goals: Improve the "typos" spell checker but also increase the quality of the cPython source code.

This was done using two spell checkers. Does this fix all typos? Most certainly it does not.


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

Copy link

cpython-cla-bot bot commented Oct 14, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

This has two goals: Improve the "typos" spell checker but also increase
the quality of the cPython source code.

This was done using two spell checkers. Does this fix all typos? Most
certainly it does not.
@picnixz
Copy link
Contributor

picnixz commented Oct 14, 2024

Please, make the diff smaller (with less files) and avoid touching anything that is related to runtime objects (e.g., class names, function names, etc). If you want to fix typos, you should only fix typos in comments or documentation but not in objects used at runtime.

I'm closing this PR since it's already a huge one and suggest to split changes with less files.

@picnixz picnixz closed this Oct 14, 2024
@picnixz
Copy link
Contributor

picnixz commented Oct 14, 2024

I also suggest having standalone PRs if you only touch the documentation, unless something must be synchronized with a library file (that is, leave the .py files untouched and only touch the .rst files). Or only change .py files. Or only change .c files.

@terryjreedy
Copy link
Member

terryjreedy commented Oct 14, 2024

(EDITED) I made PR ##125484 to fix the idlelib typos since I want them backported and know that they can be backported. Note that help.html is generated from the .html file generated from idle.rst, so the errors there must be fixed in the source. (It turns out they already were, but had not be propagated.) I verified that 'interruptable' should be 'interruptible'. Though misspelled code identifier should normally be left alone, I changed it.

@terryjreedy
Copy link
Member

Changing suppressions_path: Tools/tsan/supressions.txt to suppressions_path: Tools/tsan/suppressions.txt is wrong if the filename is actually (mis)spelled as in the original. There other cases like this. You would have to report on the PR that you checked each on. Such changes should be in a separate PR.

At least half of the proposed changes are obvious misspellings with non-controversial fixes that I would be willing to review and merge if there were a PR or PRs with (only) such. But something like changing mutex would be swalled out to mutex would be stalled out is not obvious to me (I know nothing of mutex jargon) and I would not merge it.

ember91 added a commit to ember91/cpython that referenced this pull request Oct 16, 2024
This includes:

- .rst
- .md
- .txt
- Misc/HISTORY
- README

See python#125473 for context.
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.

3 participants