Skip to content

Commit 116a5b4

Browse files
Standardize spelling: "writeable" → "writable" in library docs
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>
1 parent f3a381e commit 116a5b4

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

Doc/library/ctypes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2348,7 +2348,7 @@ Data types
23482348
.. method:: _CData.from_buffer(source[, offset])
23492349

23502350
This method returns a ctypes instance that shares the buffer of the
2351-
*source* object. The *source* object must support the writeable buffer
2351+
*source* object. The *source* object must support the writable buffer
23522352
interface. The optional *offset* parameter specifies an offset into the
23532353
source buffer in bytes; the default is zero. If the source buffer is not
23542354
large enough a :exc:`ValueError` is raised.

Doc/library/functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1704,7 +1704,7 @@ are always available. They are listed here in alphabetical order.
17041704
``fdel`` corresponding to the constructor arguments.
17051705

17061706
.. versionchanged:: 3.5
1707-
The docstrings of property objects are now writeable.
1707+
The docstrings of property objects are now writable.
17081708

17091709
.. attribute:: __name__
17101710

Doc/library/io.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -789,7 +789,7 @@ than raw I/O does.
789789

790790
.. class:: BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)
791791

792-
A buffered binary stream providing higher-level access to a writeable, non
792+
A buffered binary stream providing higher-level access to a writable, non
793793
seekable :class:`RawIOBase` raw binary stream. It inherits from
794794
:class:`BufferedIOBase`.
795795

@@ -802,7 +802,7 @@ than raw I/O does.
802802
* when a :meth:`~IOBase.seek` is requested (for :class:`BufferedRandom` objects);
803803
* when the :class:`BufferedWriter` object is closed or destroyed.
804804

805-
The constructor creates a :class:`BufferedWriter` for the given writeable
805+
The constructor creates a :class:`BufferedWriter` for the given writable
806806
*raw* stream. If the *buffer_size* is not given, it defaults to
807807
:data:`DEFAULT_BUFFER_SIZE`.
808808

@@ -840,11 +840,11 @@ than raw I/O does.
840840
.. class:: BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE, /)
841841

842842
A buffered binary stream providing higher-level access to two non seekable
843-
:class:`RawIOBase` raw binary streams---one readable, the other writeable.
843+
:class:`RawIOBase` raw binary streams---one readable, the other writable.
844844
It inherits from :class:`BufferedIOBase`.
845845

846846
*reader* and *writer* are :class:`RawIOBase` objects that are readable and
847-
writeable respectively. If the *buffer_size* is omitted it defaults to
847+
writable respectively. If the *buffer_size* is omitted it defaults to
848848
:data:`DEFAULT_BUFFER_SIZE`.
849849

850850
:class:`BufferedRWPair` implements all of :class:`BufferedIOBase`\'s methods

Doc/library/marshal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The module defines these functions:
7878
.. function:: dump(value, file, version=version, /, *, allow_code=True)
7979

8080
Write the value on the open file. The value must be a supported type. The
81-
file must be a writeable :term:`binary file`.
81+
file must be a writable :term:`binary file`.
8282

8383
If the value has (or contains an object that has) an unsupported type, a
8484
:exc:`ValueError` exception is raised --- but garbage data will also be written

Doc/library/ssl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -880,7 +880,7 @@ Constants
880880

881881
Whether the OpenSSL library has built-in support not checking subject
882882
common name and :attr:`SSLContext.hostname_checks_common_name` is
883-
writeable.
883+
writable.
884884

885885
.. versionadded:: 3.7
886886

Doc/library/subprocess.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,7 @@ Reassigning them to new values is unsupported:
910910

911911
.. attribute:: Popen.stdin
912912

913-
If the *stdin* argument was :data:`PIPE`, this attribute is a writeable
913+
If the *stdin* argument was :data:`PIPE`, this attribute is a writable
914914
stream object as returned by :func:`open`. If the *encoding* or *errors*
915915
arguments were specified or the *text* or *universal_newlines* argument
916916
was ``True``, the stream is a text stream, otherwise it is a byte stream.

Doc/library/zipfile.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ ZipFile objects
367367
Previously, a :exc:`RuntimeError` was raised.
368368

369369
.. versionchanged:: 3.13
370-
Added attributes :attr:`!name` and :attr:`!mode` for the writeable
370+
Added attributes :attr:`!name` and :attr:`!mode` for the writable
371371
file-like object.
372372
The value of the :attr:`!mode` attribute for the readable file-like
373373
object was changed from ``'r'`` to ``'rb'``.

0 commit comments

Comments
 (0)