Skip to content

Standardize spelling: "writeable" → "writable" in library docs#145294

Closed
Anandesh-Sharma wants to merge 1 commit intopython:mainfrom
Anandesh-Sharma:fix-writable-spelling
Closed

Standardize spelling: "writeable" → "writable" in library docs#145294
Anandesh-Sharma wants to merge 1 commit intopython:mainfrom
Anandesh-Sharma:fix-writable-spelling

Conversation

@Anandesh-Sharma
Copy link

@Anandesh-Sharma Anandesh-Sharma commented Feb 26, 2026

Summary

  • Standardize "writeable" → "writable" across 7 library documentation files
  • Python's own io module uses "writable" (e.g. IOBase.writable()), and the codebase overwhelmingly prefers this spelling (33 vs 11 in docs, 55 vs 3 in source code)
  • Affected files: io.rst, marshal.rst, subprocess.rst, ssl.rst, ctypes.rst, functions.rst, zipfile.rst

Test plan

  • Documentation builds without warnings
  • No functional changes (spelling-only fix)

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

Python's own io module uses "writable" (e.g. IOBase.writable()), and
the codebase overwhelmingly prefers this spelling (33 vs 11 in docs,
55 vs 3 in source). Standardize the remaining "writeable" instances in
library documentation to match.

Affected files: io.rst, marshal.rst, subprocess.rst, ssl.rst,
ctypes.rst, functions.rst, zipfile.rst

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@python-cla-bot
Copy link

The following commit authors need to sign the Contributor License Agreement:

CLA not signed

Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

Both spellings are correct, this is churn.

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

Labels

awaiting core review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants