Fix documentation typos and grammar errors#146187
Closed
yangsong97 wants to merge 4 commits intopython:mainfrom
Closed
Fix documentation typos and grammar errors#146187yangsong97 wants to merge 4 commits intopython:mainfrom
yangsong97 wants to merge 4 commits intopython:mainfrom
Conversation
|
All commit authors signed the Contributor License Agreement. |
- Fix "a HTTP/HTTPS/SSL/HTML/SMTP" → "an HTTP/HTTPS/SSL/HTML/SMTP" (article before vowel-sound acronyms) in 22 instances - Fix "a arbitrary" → "an arbitrary" in configure.rst - Fix "-X env" → "-X dev" (wrong flag name) in whatsnew/3.8.rst - Fix "are is initialized" → "are initialized" in sys.rst - Fix "a the Python" → "the Python" in first-extension-module.rst - Fix "via the passing" → "by passing" in whatsnew/3.14.rst - Fix "take into consideration" → "taken into consideration" in pending-removal-in-3.15.rst (2 instances)
f41be6b to
9cdeee1
Compare
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
Contributor
|
Thanks for the PR! After reviewing, I've decided not to merge bulk typo-fix PRs generated by automated tools. Changes like these are hard to review at scale and can occasionally introduce unintended edits. If you spot a specific, meaningful typo in a place you're actively working in, feel free to include it as part of a larger change. Closing this one for now. P.S. I would be happy to review a documentation change that corresponds to an existing issue and covers more than typo changes. Please refer to the devguide.python.org for additional information about PRs and generative AI tools. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix 29 documentation errors across 16 files:
Doc/using/configure.rstDoc/whatsnew/3.8.rst(the Python Development Mode flag is-X dev, not-X env)Doc/library/sys.rstDoc/extending/first-extension-module.rstDoc/whatsnew/3.14.rstDoc/deprecations/pending-removal-in-3.15.rst(2 instances, consistent with the correct phrasing used inpending-removal-in-3.16.rstandreference/datamodel.rst)Files changed
Doc/library/ssl.rstDoc/library/http.client.rstDoc/whatsnew/3.6.rstDoc/library/logging.handlers.rstDoc/deprecations/pending-removal-in-3.15.rstDoc/whatsnew/3.8.rstDoc/library/sys.rstDoc/extending/first-extension-module.rstDoc/whatsnew/3.14.rstDoc/using/configure.rstDoc/library/asyncio-eventloop.rstDoc/library/xmlrpc.client.rstDoc/library/pydoc.rstDoc/library/shutil.rstDoc/howto/urllib2.rstDoc/README.rst📚 Documentation preview 📚: https://cpython-previews--146187.org.readthedocs.build/