Skip to content

Commit e50acef

Browse files
authored
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
1 parent 8276778 commit e50acef

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
@@ -1336,12 +1336,12 @@ Connection objects are usually created using
13361336
Note that multiple connection objects may be polled at once by
13371337
using :func:`multiprocessing.connection.wait`.
13381338

1339-
.. method:: send_bytes(buffer[, offset[, size]])
1339+
.. method:: send_bytes(buf[, offset[, size]])
13401340

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

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

@@ -1361,18 +1361,18 @@ Connection objects are usually created using
13611361
alias of :exc:`OSError`.
13621362

13631363

1364-
.. method:: recv_bytes_into(buffer[, offset])
1364+
.. method:: recv_bytes_into(buf[, offset])
13651365

1366-
Read into *buffer* a complete message of byte data sent from the other end
1366+
Read into *buf* a complete message of byte data sent from the other end
13671367
of the connection and return the number of bytes in the message. Blocks
13681368
until there is something to receive. Raises
13691369
:exc:`EOFError` if there is nothing left to receive and the other end was
13701370
closed.
13711371

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

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

0 commit comments

Comments
 (0)