Possible issue in multiprocessing doc

[1a1a11a]

BPO	32051
Nosy	@berkerpeksag, @1a1a11a
PRs	bpo-32051: update multiprocessing doc #4469 [3.6] bpo-32051: Fix name shadowing in multiprocessing docs (GH-4469) #4577

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2017-11-27.01:23:18.907>
created_at = <Date 2017-11-16.17:27:04.327>
labels = ['easy', 'type-bug', '3.7', 'docs']
title = 'Possible issue in multiprocessing doc'
updated_at = <Date 2017-11-27.01:23:18.906>
user = 'https://github.com/1a1a11a'

bugs.python.org fields:

activity = <Date 2017-11-27.01:23:18.906>
actor = 'berker.peksag'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-11-27.01:23:18.907>
closer = 'berker.peksag'
components = ['Documentation']
creation = <Date 2017-11-16.17:27:04.327>
creator = '1a1a11a'
dependencies = []
files = []
hgrepos = []
issue_num = 32051
keywords = ['patch', 'easy']
message_count = 7.0
messages = ['306389', '306408', '306409', '306509', '307030', '307031', '307032']
nosy_count = 3.0
nosy_names = ['docs@python', 'berker.peksag', '1a1a11a']
pr_nums = ['4469', '4577']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue32051'
versions = ['Python 3.6', 'Python 3.7']

[1a1a11a]

in multiprocessing doc https://docs.python.org/3.6/library/multiprocessing.html

under 17.2.2.7.2. Using a remote manager, 
>>> from multiprocessing.managers import BaseManager
>>> import queue
>>> queue = queue.Queue()
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue', callable=lambda:queue)
>>> m = QueueManager(address=('', 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()

queue is used as both module name and variable name, should this be avoided?

[berkerpeksag]

The example itself works fine, but I agree that it would be better to use a better name. We could replace ('foo.bar.org', 50000) in the following examples with ('', 50000) too.

Would you like to send a PR? The documentation file is located at Doc/library/multiprocessing.rst.

[1a1a11a]

Thank you for answering!
Yes, I would be very happy to do that, this is going to be my first contribution! :)

[1a1a11a]

Hi Berker,
I didn't update "following examples with ('', 50000) too." because this is different than the previous one, this is client connecting to server, so hostname cannot be empty string.

[berkerpeksag]

New changeset c172fc5 by Berker Peksag (Jason Yang) in branch 'master':
bpo-32051: Fix name shadowing in multiprocessing docs (GH-4469)
c172fc5

[berkerpeksag]

New changeset 8a95753 by Berker Peksag (Miss Islington (bot)) in branch '3.6':
bpo-32051: Fix name shadowing in multiprocessing docs (GH-4469)
8a95753

[berkerpeksag]

Thanks!