[issue26980] The path argument of asyncio.BaseEventLoop.create_unix_connection is not documented
New submission from texttheater:
The documentation does not say what this argument is for.
It says "See the BaseEventLoop.create_connection() method for parameters", but that method does not have a path argument.
The argument seems to be required unless the keyword argument sock is given.
----------
assignee: docs@python
components: Documentation
messages: 265170
nosy: docs@python, texttheater
priority: normal
severity: normal
status: open
title: The path argument of asyncio.BaseEventLoop.create_unix_connection is not documented
versions: Python 3.4, Python 3.5, Python 3.6
_______________________________________
Python tracker
Changes by Ned Deily
Guido van Rossum added the comment:
It's the name of the UNIX domain socket.
----------
_______________________________________
Python tracker
Berker Peksag added the comment:
Thanks for the report. I'm marking this as an easy documentation issue. BaseEventLoop is now AbstractEventLoop (87e3a58ed3c3) and the documentation of AbstractEventLoop.create_unix_connection() can be found in Doc/library/asyncio-eventloop.rst. Guido already explained what it means in msg266111 so what we need is to convert Guido's answer to a proper patch.
----------
keywords: +easy
nosy: +berker.peksag
stage: -> needs patch
type: -> enhancement
versions: +Python 3.7
_______________________________________
Python tracker
Марк Коренберг added the comment:
It will be nice if someone also adds if abstract UNIX sockets are supported. And also about bytes/str path support.
----------
nosy: +mmarkk
_______________________________________
Python tracker
Mariatta Wijaya added the comment:
Hi, I updated the documentation explaining the path argument.
Let me know if this works. Thanks :)
----------
keywords: +patch
nosy: +Mariatta
Added file: http://bugs.python.org/file45329/issue26980.patch
_______________________________________
Python tracker
Guido van Rossum added the comment:
LGTM, will apply shortly.
----------
_______________________________________
Python tracker
Roundup Robot added the comment:
New changeset b97b0201c2f4 by Guido van Rossum in branch '3.5':
Issue #26980: Improve docs for create_unix_connection(). By Mariatta.
https://hg.python.org/cpython/rev/b97b0201c2f4
New changeset ddbba4739ef4 by Guido van Rossum in branch '3.6':
Issue #26980: Improve docs for create_unix_connection(). By Mariatta. (3.5->3.6)
https://hg.python.org/cpython/rev/ddbba4739ef4
New changeset d6f4c1b864e6 by Guido van Rossum in branch 'default':
Issue #26980: Improve docs for create_unix_connection(). By Mariatta. (3.6->3.7)
https://hg.python.org/cpython/rev/d6f4c1b864e6
----------
nosy: +python-dev
_______________________________________
Python tracker
Changes by Guido van Rossum
participants (7)
-
Berker Peksag
-
Guido van Rossum
-
Mariatta Wijaya
-
Ned Deily
-
Roundup Robot
-
texttheater
-
Марк Коренберг