This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: multiprocessing AF_PIPE name format is slightly confusing in the docs
Type: enhancement Stage:
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9, Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Antony.Lee, docs@python, eryksun
Priority: normal Keywords:

Created on 2021-05-20 12:11 by Antony.Lee, last changed 2022-04-11 14:59 by admin.

Messages (2)
msg394020 - (view) Author: Antony Lee (Antony.Lee) * Date: 2021-05-20 12:11
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.
msg394078 - (view) Author: Eryk Sun (eryksun) * (Python triager) Date: 2021-05-20 23:19
There's a formatting problem in Doc/library/multiprocessing.rst due to consumption of the backslashes in multiple steps. The following keeps all of the required backslashes in the HTML output:

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

Or just use a regular literal and rely on the reader to understand that "{PipeName}" and "{ServerName}" are parameters:

    * An ``'AF_PIPE'`` address is a string of the form
      ``r'\\.\pipe\{PipeName}'``.  To use :func:`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.
History
Date User Action Args
2022-04-11 14:59:45adminsetgithub: 88355
2021-05-20 23:19:26eryksunsetversions: + Python 3.8, Python 3.9, Python 3.10, Python 3.11
nosy: + eryksun

messages: + msg394078

type: enhancement
2021-05-20 12:11:12Antony.Leecreate