Skip to content

Fix documentation typos and grammar errors#146187

Open
yangsong97 wants to merge 3 commits intopython:mainfrom
yangsong97:fix-documentation-typos
Open

Fix documentation typos and grammar errors#146187
yangsong97 wants to merge 3 commits intopython:mainfrom
yangsong97:fix-documentation-typos

Conversation

@yangsong97
Copy link

@yangsong97 yangsong97 commented Mar 19, 2026

Summary

Fix 29 documentation errors across 16 files:

  • Article errors before vowel-sound acronyms (22 instances): "a HTTP" → "an HTTP", "a HTTPS" → "an HTTPS", "a SSL" → "an SSL", "a HTML" → "an HTML", "a SMTP" → "an SMTP". English article choice depends on pronunciation, not spelling — these acronyms start with vowel sounds ("aitch", "ess").
  • "a arbitrary" → "an arbitrary" in Doc/using/configure.rst
  • Wrong flag name: "-X env" → "-X dev" in Doc/whatsnew/3.8.rst (the Python Development Mode flag is -X dev, not -X env)
  • Grammar error: "are is initialized" → "are initialized" in Doc/library/sys.rst
  • Stray article: "a the Python" → "the Python" in Doc/extending/first-extension-module.rst
  • Grammar error: "via the passing" → "by passing" in Doc/whatsnew/3.14.rst
  • Grammar error: "take into consideration" → "taken into consideration" in Doc/deprecations/pending-removal-in-3.15.rst (2 instances, consistent with the correct phrasing used in pending-removal-in-3.16.rst and reference/datamodel.rst)

Files changed

File Fixes
Doc/library/ssl.rst 6 article fixes (SSL, SMTP)
Doc/library/http.client.rst 6 article fixes (HTTP, HTTPS)
Doc/whatsnew/3.6.rst 2 article fixes (HTTP)
Doc/library/logging.handlers.rst 2 article fixes (HTTP, HTTPS)
Doc/deprecations/pending-removal-in-3.15.rst 2 grammar fixes
Doc/whatsnew/3.8.rst 1 wrong flag name fix
Doc/library/sys.rst 1 grammar fix
Doc/extending/first-extension-module.rst 1 typo fix
Doc/whatsnew/3.14.rst 1 grammar fix
Doc/using/configure.rst 1 article fix
Doc/library/asyncio-eventloop.rst 1 article fix (SSL)
Doc/library/xmlrpc.client.rst 1 article fix (HTTP)
Doc/library/pydoc.rst 1 article fix (HTTP)
Doc/library/shutil.rst 1 article fix (HTTP)
Doc/howto/urllib2.rst 1 article fix (HTML)
Doc/README.rst 1 article fix (HTML)

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

@python-cla-bot
Copy link

python-cla-bot bot commented Mar 19, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

- 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)
yangsong97 and others added 2 commits March 20, 2026 00:32
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
@giampaolo giampaolo removed their request for review March 20, 2026 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants