Skip to content

Fix typos and grammar errors across documentation#144709

Merged
AlexWaygood merged 14 commits intopython:mainfrom
him2him2:fix-doc-typos-and-grammar
Feb 11, 2026
Merged

Fix typos and grammar errors across documentation#144709
AlexWaygood merged 14 commits intopython:mainfrom
him2him2:fix-doc-typos-and-grammar

Conversation

@him2him2
Copy link
Contributor

@him2him2 him2him2 commented Feb 11, 2026

Fix 77 typos and grammar errors in 39 documentation files.

Categories of fixes:

  • Spelling errors: "seperately" → "separately", "preveiously" → "previously"
  • Subject-verb agreement: "functions uses" → "functions use", "protocol require" → "protocol requires", "names takes" → "names take"
  • Missing words: "if there no" → "if there is no", "must one of" → "must be one of", "are longer called" → "are no longer called"
  • Extra words: "effects with involving" → "effects involving", "whose the result" → "whose result", "the its behavior" → "its behavior"
  • Wrong prepositions: "obey to the following" → "obey the following", "equals to" → "equals"
  • Wrong word forms: "fallback on" → "fall back on", "In the later case" → "In the latter case", "most noticeable" → "most notably"
  • Grammatical fixes: "allows to run" → "allows you to run", "equivalent to call" → "equivalent to calling"
  • Duplicated text: "a lock a lock" → "a lock", "next the timer next fires" → "the timer next fires"
  • Miscellaneous: double space, missing space before parenthesis, American English spelling ("behaviour" → "behavior")

Files changed by section:

Section Files Fixes
Doc/tutorial/ 5 7
Doc/c-api/ 7 13
Doc/library/ 22 52
Misc (glossary, bugs, copyright, license, deprecations) 5 5
Total 39 77

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

Fix 77 issues in 39 documentation files including:

- Spelling errors (e.g., "seperately", "preveiously")
- Subject-verb agreement (e.g., "functions uses" -> "functions use")
- Missing or extra words (e.g., "if there no" -> "if there is no")
- Wrong prepositions (e.g., "obey to" -> "obey", "equals to" -> "equals")
- Wrong word forms (e.g., "fallback" -> "fall back", "later" -> "latter")
- Grammatical fixes (e.g., "allows to run" -> "allows you to run")
- Duplicated text (e.g., "a lock a lock" -> "a lock")
- Miscellaneous (double space, missing space, American English spelling)
@python-cla-bot
Copy link

python-cla-bot bot commented Feb 11, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Feb 11, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Feb 11, 2026
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! Mostly looks good. Some suggestions.

has been used, e.g. amount of time spent running in user mode or number of times
the process was swapped out of main memory. Some values are dependent on the
clock tick internal, e.g. the amount of memory the process is using.
clock tick interval, e.g. the amount of memory the process is using.
Copy link
Member

@AlexWaygood AlexWaygood Feb 11, 2026

Choose a reason for hiding this comment

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

is this definitely meant to be "interval" rather than "internals"? (If we're not sure, I'd just revert this change for now.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question! The original text was actually clock tick internal (not "internals"), so the choice was between "interval" and "internal". "Clock tick interval" is standard Unix/POSIX terminology — it refers to the duration between system clock ticks. The sentence reads: "Some values are dependent on the clock tick interval, e.g. the amount of memory the process is using." That lines up with how getrusage(2) works, where certain resource measurements are quantized to clock tick boundaries.

Happy to revert if you'd prefer to be cautious though!

Copy link
Member

Choose a reason for hiding this comment

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

OK, that makes sense to me, thanks for checking!

him2him2 and others added 10 commits February 11, 2026 09:49
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Revert copyright.rst, license.rst (legal documents should not be
modified), and inputoutput.rst (British spelling "behaviour" is
acceptable in CPython docs).
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@giampaolo giampaolo removed their request for review February 11, 2026 15:15
@him2him2
Copy link
Contributor Author

Thanks so much for the thorough review @AlexWaygood! Really appreciate you taking the time to go through all of these — your suggestions were spot on. All changes have been applied.

@AlexWaygood AlexWaygood added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Feb 11, 2026
@AlexWaygood AlexWaygood merged commit 3718f4b into python:main Feb 11, 2026
33 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Feb 11, 2026
@miss-islington-app
Copy link

Thanks @him2him2 for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link

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

cherry_picker 3718f4be60ebb0725b35f597a9de3f7a93ba9f72 3.14

@miss-islington-app
Copy link

Sorry, @him2him2 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 3718f4be60ebb0725b35f597a9de3f7a93ba9f72 3.13

@AlexWaygood
Copy link
Member

@him2him2, would you be able to take care of the backports using the instructions the bot gave?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip issue skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants