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: create_subprocess_exec doc doesn't match software
Type: behavior Stage: resolved
Components: asyncio, Documentation Versions: Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Torrin Jones, carlbordum, docs@python, vstinner, yselivanov
Priority: normal Keywords:

Created on 2017-03-24 05:20 by Torrin Jones, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (4)
msg290077 - (view) Author: Torrin Jones (Torrin Jones) Date: 2017-03-24 05:20
The documentation for asyncio.create_subprocess_exec says this is the definition . . .

asyncio.create_subprocess_exec(*args, stdin=None, stdout=None, stderr=None, loop=None, limit=None, **kwds)

The actual definition is this . . .

def create_subprocess_exec(program, *args, stdin=None, stdout=None,            
                           stderr=None, loop=None,                             
                           limit=streams._DEFAULT_LIMIT, **kwds)

Notice the first argument (program) at the start of the actual definition.
msg290603 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2017-03-27 12:57
Ah, I wrote "def create_subprocess_exec(program, *args," to implicitly check that args is non empty.

We can either change the function prototype to check that args is non-empty in the body, or just update the documentation.

The documentation is not exactly wrong :-)
msg377779 - (view) Author: Carl Bordum Hansen (carlbordum) * Date: 2020-10-01 18:24
This was fixed in https://github.com/python/cpython/pull/12598
msg377781 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2020-10-01 21:16
> This was fixed in https://github.com/python/cpython/pull/12598

Right, thanks. I close the issue.

commit 1328375ad1c91f25a1500945a67b0ef36e387527
Author: Dima Tisnek <dimaqq@gmail.com>
Date:   Fri Apr 5 23:02:28 2019 +0900

    Fix doc for create_subprocess_exec (GH-12598)
    
    
    
    Add missing `program` argument to asyncio.create_subprocess_exec documentation.
History
Date User Action Args
2022-04-11 14:58:44adminsetgithub: 74079
2020-10-01 21:16:16vstinnersetstatus: open -> closed
resolution: fixed
messages: + msg377781

stage: resolved
2020-10-01 18:24:11carlbordumsetnosy: + carlbordum
messages: + msg377779
2017-03-27 12:57:26vstinnersetnosy: + vstinner
messages: + msg290603
2017-03-24 22:25:35Torrin Jonessetassignee: docs@python

type: behavior
components: + Documentation
nosy: + docs@python
2017-03-24 05:20:17Torrin Jonescreate