Skip to content

Commit 248bd44

Browse files
mdavis-xyzmiss-islington
authored andcommitted
gh-148763: Fix paramter name in multiprocessing.connection.send_bytes/recv_bytes_into docs (GH-126603)
(cherry picked from commit e50acef0b2c2057874a9eec98c37ca6cf8ee98e1) Co-authored-by: Matthew Davis <7035647+mdavis-xyz@users.noreply.github.com> Doc: Fix buf argument name in multiprocessing connection send_bytes
1 parent ec1d863 commit 248bd44

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Doc/library/multiprocessing.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,12 +1326,12 @@ Connection objects are usually created using
13261326
Note that multiple connection objects may be polled at once by
13271327
using :func:`multiprocessing.connection.wait`.
13281328

1329-
.. method:: send_bytes(buffer[, offset[, size]])
1329+
.. method:: send_bytes(buf[, offset[, size]])
13301330

13311331
Send byte data from a :term:`bytes-like object` as a complete message.
13321332

1333-
If *offset* is given then data is read from that position in *buffer*. If
1334-
*size* is given then that many bytes will be read from buffer. Very large
1333+
If *offset* is given then data is read from that position in *buf*. If
1334+
*size* is given then that many bytes will be read from *buf*. Very large
13351335
buffers (approximately 32 MiB+, though it depends on the OS) may raise a
13361336
:exc:`ValueError` exception
13371337

@@ -1351,18 +1351,18 @@ Connection objects are usually created using
13511351
alias of :exc:`OSError`.
13521352

13531353

1354-
.. method:: recv_bytes_into(buffer[, offset])
1354+
.. method:: recv_bytes_into(buf[, offset])
13551355

1356-
Read into *buffer* a complete message of byte data sent from the other end
1356+
Read into *buf* a complete message of byte data sent from the other end
13571357
of the connection and return the number of bytes in the message. Blocks
13581358
until there is something to receive. Raises
13591359
:exc:`EOFError` if there is nothing left to receive and the other end was
13601360
closed.
13611361

1362-
*buffer* must be a writable :term:`bytes-like object`. If
1362+
*buf* must be a writable :term:`bytes-like object`. If
13631363
*offset* is given then the message will be written into the buffer from
13641364
that position. Offset must be a non-negative integer less than the
1365-
length of *buffer* (in bytes).
1365+
length of *buf* (in bytes).
13661366

13671367
If the buffer is too short then a :exc:`BufferTooShort` exception is
13681368
raised and the complete message is available as ``e.args[0]`` where ``e``

0 commit comments

Comments
 (0)