]> granicus.if.org Git - python/commit
bpo-31965: fix doc for multiprocessing.connection.Client and Listener (GH-4304) ...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 7 Nov 2017 16:20:24 +0000 (08:20 -0800)
committerAntoine Pitrou <pitrou@free.fr>
Tue, 7 Nov 2017 16:20:24 +0000 (17:20 +0100)
commitd9c61c2a2662761dc89e0be14ceb7ea57531c836
tree6b12d9e779d8c0f8527b543141b051b99719dac3
parenta5dca7d173f9f1d98b13939498269ce3e35b3a07
bpo-31965: fix doc for multiprocessing.connection.Client and Listener (GH-4304) (#4321)

* 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.pyGH-L483 (master)
- https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.pyGH-L478 (3.6)
- https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.pyGH-L478 (3.5)
- https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.pyGH-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.
(cherry picked from commit 1e5d54cfa031f1de9ee2d2e968e0551b6e2397b7)
Doc/library/multiprocessing.rst