https://github.com/python/cpython/commit/e50acef0b2c2057874a9eec98c37ca6cf8ee98e1
commit: e50acef0b2c2057874a9eec98c37ca6cf8ee98e1
branch: main
author: Matthew Davis <[email protected]>
committer: gpshead <[email protected]>
date: 2026-04-19T17:05:50-07:00
summary:
gh-148763: Fix paramter name in
`multiprocessing.connection.send_bytes/recv_bytes_into` docs (GH-126603)
Doc: Fix buf argument name in multiprocessing connection send_bytes
files:
M Doc/library/multiprocessing.rst
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index 63bc252e129dfb..3ceb5e717c4825 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -1336,12 +1336,12 @@ Connection objects are usually created using
Note that multiple connection objects may be polled at once by
using :func:`multiprocessing.connection.wait`.
- .. method:: send_bytes(buffer[, offset[, size]])
+ .. method:: send_bytes(buf[, offset[, size]])
Send byte data from a :term:`bytes-like object` as a complete message.
- If *offset* is given then data is read from that position in *buffer*.
If
- *size* is given then that many bytes will be read from buffer. Very
large
+ If *offset* is given then data is read from that position in *buf*. If
+ *size* is given then that many bytes will be read from *buf*. Very large
buffers (approximately 32 MiB+, though it depends on the OS) may raise a
:exc:`ValueError` exception
@@ -1361,18 +1361,18 @@ Connection objects are usually created using
alias of :exc:`OSError`.
- .. method:: recv_bytes_into(buffer[, offset])
+ .. method:: recv_bytes_into(buf[, offset])
- Read into *buffer* a complete message of byte data sent from the other
end
+ Read into *buf* a complete message of byte data sent from the other end
of the connection and return the number of bytes in the message. Blocks
until there is something to receive. Raises
:exc:`EOFError` if there is nothing left to receive and the other end was
closed.
- *buffer* must be a writable :term:`bytes-like object`. If
+ *buf* must be a writable :term:`bytes-like object`. If
*offset* is given then the message will be written into the buffer from
that position. Offset must be a non-negative integer less than the
- length of *buffer* (in bytes).
+ length of *buf* (in bytes).
If the buffer is too short then a :exc:`BufferTooShort` exception is
raised and the complete message is available as ``e.args[0]`` where ``e``
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
