[New-bugs-announce] [issue44189] multiprocessing AF_PIPE name format is slightly confusing in the docs

[Antony Lee]

New submission from Antony Lee <anntzer.lee at gmail.com>:

https://docs.python.org/3/library/multiprocessing.html#address-formats currently states

> An 'AF_PIPE' address is a string of the form r'\.\pipe{PipeName}'. To use Client() to connect to a named pipe on a remote computer called ServerName one should use an address of the form r'\ServerName\pipe{PipeName}' instead.

which suggests that if the pipe is named "foo", the string should be r'\.\pipe{foo}' (especially given that the other substituted string, ServerName, is given in italics... but actually the correct format is r'\.\pipe\foo'.

Hence I would suggest fixing the markup to give name formats as r'\.pipe\PipeName' where PipeName, is in italics, like ServerName.

----------
assignee: docs at python
components: Documentation
messages: 394020
nosy: Antony.Lee, docs at python
priority: normal
severity: normal
status: open
title: multiprocessing AF_PIPE name format is slightly confusing in the docs

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue44189>
_______________________________________