gh-148763: Fix paramter name in multiprocessing.connection.send_bytes/recv_bytes_into docs

[mdavis-xyz]

Documentation

The documentation for multiprocessing.connection.Connection.send_bytes says that the first argument is called buffer.

send_bytes(buffer[, offset[, size]])

When I run:

from multiprocessing import Pipe

c1, c2 = Pipe(duplex=True)

c1.send_bytes(buffer=b'123')

(On python 3.13)

TypeError: _ConnectionBase.send_bytes() got an unexpected keyword argument 'buffer'

In connection.py the argument is defined as buf not buffer.

def send_bytes(self, buf, offset=0, size=None):

Indeed when I instead write c1.send_bytes(buf=b'123'), it runs without throwing an exception.

The same is true of recv_bytes_into.

Note: I did not raise an issue for this, because it is so trivial.

---

📚 Documentation preview 📚: https://cpython-previews--126603.org.readthedocs.build/

• Issue: wrong arg name in multiprocessing connection send_bytes recv_bytes_into: buf vs buffer #148763

[mdavis-xyz]

Please add the “skip issue” label to this PR.

[github-actions]

This PR is stale because it has been open for 30 days with no activity.

[python-cla-bot]

All commit authors signed the Contributor License Agreement.

[mdavis-xyz]

This PR was stale for a while. I think it was because I hadn't signed the CLA. I have now.

The CI complains that there's no issue. I raised an issue, but the CI hasn't noticed that change. I don't know how to re-run the CI. The steps here describe a button which I cannot find on this page.

Please re-run the CI for me, and then review and merge.

[miss-islington-app]

Thanks @mdavis-xyz for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

[bedevere-app]

GH-148786 is a backport of this pull request to the 3.14 branch.

[bedevere-app]

GH-148787 is a backport of this pull request to the 3.13 branch.