-
-
Notifications
You must be signed in to change notification settings - Fork 34.1k
Fix typos and grammar errors across documentation #144709
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
Conversation
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)
AlexWaygood
left a comment
There was a problem hiding this 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. |
There was a problem hiding this comment.
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.)
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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!
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>
|
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. |
|
Thanks @him2him2 for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
|
Sorry, @him2him2 and @AlexWaygood, I could not cleanly backport this to |
|
Sorry, @him2him2 and @AlexWaygood, I could not cleanly backport this to |
|
@him2him2, would you be able to take care of the backports using the instructions the bot gave? |
Fix 77 typos and grammar errors in 39 documentation files.
Categories of fixes:
Files changed by section:
Doc/tutorial/Doc/c-api/Doc/library/glossary,bugs,copyright,license,deprecations)📚 Documentation preview 📚: https://cpython-previews--144709.org.readthedocs.build/