New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

bpo-32362: Fix references to non-existent multiprocessing.Connection() #6223

Merged

serhiy-storchaka merged 4 commits into python:master from bbayles:mp-connection-docs-32362

Apr 29, 2018

Contributor

bbayles commented Mar 25, 2018 •

edited

Loading

This PR fixes references to multiprocessing.Connection() in the multiprocessing docs - they should be multiprocessing.connection.Connection().

We set the ~~module~~ currentmodule directive such that Sphinx renders the class name correctly (here), ~~but~~ since module:: multiprocessing.connection is already used once (here) ~~, we also set noindex to avoid messing with the document structure~~.

https://bugs.python.org/issue32362


          bpo-32362: Fix references to non-existent multiprocessing.Connection()

44e1adb

the-knights-who-say-ni added the CLA signed label

bedevere-bot added the awaiting review label

Member

serhiy-storchaka commented Mar 27, 2018

Would the currentmodule directive be helped here?


          Use currentmodule directive

0e27712

Contributor Author

bbayles commented Mar 27, 2018

Good suggestion. That directive is aimed at this issue; I've made that change.

serhiy-storchaka reviewed

View reviewed changes

Member

serhiy-storchaka left a comment

Thank you. But such minor documentation changes usually don't need a news entry.

serhiy-storchaka added needs backport to 3.6 docs labels

Contributor Author

bbayles commented Mar 28, 2018

Shall I remove the news entry? I put it in because I thought the bedevere-bot would issue me a red check mark.

serhiy-storchaka added the skip news label

Member

serhiy-storchaka commented Mar 28, 2018

This warning can be silenced.


          Delete 2018-03-24-20-31-56.bpo-32362.CeGpEt.rst

53693df

Contributor Author

bbayles commented Mar 28, 2018

Right-o.

serhiy-storchaka reviewed

View reviewed changes

Doc/library/multiprocessing.rst Outdated

@@ @@ -2269,7 +2274,7 @@ Listeners and Clients @@
                  :synopsis: API for dealing with sockets.
               Usually message passing between processes is done using queues or by using
-              :class:`~multiprocessing.Connection` objects returned by
+              :class:`~multiprocessing.connection.Connection` objects returned by

Member

serhiy-storchaka Mar 28, 2018

Can be just :class:`Connection`.

Doc/library/multiprocessing.rst Outdated

@@ @@ -2299,7 +2304,7 @@ multiple connections at the same time. @@
               .. function:: Client(address[, family[, authkey]])
                  Attempt to set up a connection to the listener which is using address
-                 *address*, returning a :class:`~multiprocessing.Connection`.
+                 *address*, returning a :class:`~multiprocessing.connection.Connection`.

Member

serhiy-storchaka Mar 28, 2018

Can be just :class:`Connection`.

Doc/library/multiprocessing.rst Outdated

@@ @@ -2349,8 +2354,8 @@ multiple connections at the same time. @@
                  .. method:: accept()
                     Accept a connection on the bound socket or named pipe of the listener
-                    object and return a :class:`~multiprocessing.Connection` object.  If
-                    authentication is attempted and fails, then
+                    object and return a :class:`~multiprocessing.connection.Connection` object.

Member

serhiy-storchaka Mar 28, 2018

Can be just :class:`Connection`.

Doc/library/multiprocessing.rst Outdated

               Authentication keys
               ~~~~~~~~~~~~~~~~~~~
-              When one uses :meth:`Connection.recv <multiprocessing.Connection.recv>`, the
-              data received is automatically
+              When one uses :meth:`Connection.recv <multiprocessing.connection.Connection.recv>`,

Member

serhiy-storchaka Mar 28, 2018

Can be just :meth:`Connection.recv`.

Doc/library/multiprocessing.rst

@@ @@ -1021,6 +1022,8 @@ Miscellaneous @@
               Connection Objects
               ~~~~~~~~~~~~~~~~~~
+              .. currentmodule:: multiprocessing.connection

Member

serhiy-storchaka Mar 28, 2018

In the line below

Therefore, unless the connection object was produced using :func:`Pipe` you

:func:`Pipe` is not converted to a link because the current module is multiprocessing.connection.


          Further updates for currentmodule

9a69a01

Contributor Author

bbayles commented Mar 29, 2018

Thanks for looking over this. I've incorporated your suggestions.

serhiy-storchaka approved these changes

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels

Member

serhiy-storchaka commented Apr 29, 2018

Thank you for your contribution @bbayles!

serhiy-storchaka merged commit 9f3535c into python:master

Contributor

miss-islington commented Apr 29, 2018

Thanks @bbayles for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7.
🐍🍒⛏🤖

bedevere-bot removed the awaiting merge label

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request


          bpo-32362: Fix references to non-existent multiprocessing.Connection() (

4a23d44

pythonGH-6223)

(cherry picked from commit 9f3535c)

Co-authored-by: Bo Bayles <bbayles@gmail.com>

bedevere-bot commented Apr 29, 2018

GH-6639 is a backport of this pull request to the 3.7 branch.

bedevere-bot removed the needs backport to 3.7 label

Contributor

miss-islington commented Apr 29, 2018

Sorry, @bbayles and @serhiy-storchaka, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 9f3535c9cde8813ce631d6ebe4d790682f594828 2.7

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request


          bpo-32362: Fix references to non-existent multiprocessing.Connection() (

0ddcdcd

pythonGH-6223)

(cherry picked from commit 9f3535c)

Co-authored-by: Bo Bayles <bbayles@gmail.com>

bedevere-bot commented Apr 29, 2018

GH-6640 is a backport of this pull request to the 3.6 branch.

bedevere-bot removed the needs backport to 3.6 label

miss-islington added a commit that referenced this pull request


          bpo-32362: Fix references to non-existent multiprocessing.Connection() (

cebce2e

GH-6223)

(cherry picked from commit 9f3535c)

Co-authored-by: Bo Bayles <bbayles@gmail.com>

miss-islington added a commit that referenced this pull request


          bpo-32362: Fix references to non-existent multiprocessing.Connection() (

9a039d5

GH-6223)

(cherry picked from commit 9f3535c)

Co-authored-by: Bo Bayles <bbayles@gmail.com>

Contributor Author

bbayles commented Apr 29, 2018

Many thanks for the guidance on this, @serhiy-storchaka . While you've got the multiprocessing docs in your mind, PR #5850 is another addition that may be worth a look?

bbayles added a commit to bbayles/cpython that referenced this pull request


          [2.7] bpo-32362: Fix references to non-existent multiprocessing.Conne…

3fc1cb2

…ction() (pythonGH-6223).

(cherry picked from commit 9f3535c)

Co-authored-by: Bo Bayles <bbayles@gmail.com>

bbayles mentioned this pull request

[2.7] bpo-32362: Fix references to non-existent multiprocessing.Connection() (GH-6223) #6646

Merged

bedevere-bot commented Apr 29, 2018

GH-6646 is a backport of this pull request to the 2.7 branch.

bedevere-bot removed the needs backport to 2.7 label

bbayles mentioned this pull request

[2.7] Fix multiprocessing docs' list of exceptions #6647

Merged

serhiy-storchaka pushed a commit that referenced this pull request


          [2.7] bpo-32362: Fix references to non-existent multiprocessing.Conne…

4a1bc26

…ction() (GH-6223) (GH-6646)

(cherry picked from commit 9f3535c)

Co-authored-by: Bo Bayles <bbayles@gmail.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels