Skip to content

Commit bef4d84

Browse files
[3.13] gh-148763: Fix paramter name in multiprocessing.connection.send_bytes/recv_bytes_into docs (GH-126603) (#148787)
gh-148763: Fix paramter name in `multiprocessing.connection.send_bytes/recv_bytes_into` docs (GH-126603) (cherry picked from commit e50acef) Doc: Fix buf argument name in multiprocessing connection send_bytes Co-authored-by: Matthew Davis <7035647+mdavis-xyz@users.noreply.github.com>
1 parent 01f7218 commit bef4d84

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

1296-
.. method:: send_bytes(buffer[, offset[, size]])
1296+
.. method:: send_bytes(buf[, offset[, size]])
12971297

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

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

@@ -1318,18 +1318,18 @@ Connection objects are usually created using
13181318
alias of :exc:`OSError`.
13191319

13201320

1321-
.. method:: recv_bytes_into(buffer[, offset])
1321+
.. method:: recv_bytes_into(buf[, offset])
13221322

1323-
Read into *buffer* a complete message of byte data sent from the other end
1323+
Read into *buf* a complete message of byte data sent from the other end
13241324
of the connection and return the number of bytes in the message. Blocks
13251325
until there is something to receive. Raises
13261326
:exc:`EOFError` if there is nothing left to receive and the other end was
13271327
closed.
13281328

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

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

0 commit comments

Comments
 (0)