]> granicus.if.org Git - python/commit
bpo-31965: fix doc for multiprocessing.connection.Client and Listener (#4304)
authorJelle Zijlstra <jelle.zijlstra@gmail.com>
Tue, 7 Nov 2017 16:13:02 +0000 (08:13 -0800)
committerAntoine Pitrou <pitrou@free.fr>
Tue, 7 Nov 2017 16:13:02 +0000 (17:13 +0100)
commit1e5d54cfa031f1de9ee2d2e968e0551b6e2397b7
treed0a8bfabbbb5eb5cb6b6f525f81d583fb192b327
parent22b1128559bdeb96907da5840960691bb050d11a
bpo-31965: fix doc for multiprocessing.connection.Client and Listener (#4304)

* fix doc for multiprocessing.connection.Client

The authenticate argument does not exist on either Client or Listener:
- https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.py#L483 (master)
- https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.py#L478 (3.6)
- https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.py#L478 (3.5)
- https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.py#L487 (3.4)
The documentation also claimed that these functions will call `current_process().auth_key`, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior.

Also made some small changes to vary sentence structure.
Doc/library/multiprocessing.rst