[3.6] bpo-31965: fix doc for multiprocessing.connection.Client and Listener (GH-4304)#4321
Merged
Merged
Conversation
…pythonGH-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.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 1e5d54c)
Contributor
Author
|
@JelleZijlstra and @pitrou: Backport status check is done, and it's a success ✅ . |
Contributor
Author
|
Thanks, @pitrou! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The authenticate argument does not exist on either Client or Listener:
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 1e5d54c)
https://bugs.python.org/issue31965