Skip to content

Commit ac29256

Browse files
committed
Doc: Fix buf argument name in multiprocessing connection send_bytes
1 parent 54c63a3 commit ac29256

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

1225-
.. method:: send_bytes(buffer[, offset[, size]])
1225+
.. method:: send_bytes(buf[, offset[, size]])
12261226

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

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

@@ -1247,18 +1247,18 @@ Connection objects are usually created using
12471247
alias of :exc:`OSError`.
12481248

12491249

1250-
.. method:: recv_bytes_into(buffer[, offset])
1250+
.. method:: recv_bytes_into(buf[, offset])
12511251

1252-
Read into *buffer* a complete message of byte data sent from the other end
1252+
Read into *buf* a complete message of byte data sent from the other end
12531253
of the connection and return the number of bytes in the message. Blocks
12541254
until there is something to receive. Raises
12551255
:exc:`EOFError` if there is nothing left to receive and the other end was
12561256
closed.
12571257

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

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

0 commit comments

Comments
 (0)