[docs] subprocess.run doc doesn't show the new capture_output in the parameter list
David.Raymond at tomtom.com
Tue Jul 24 09:50:41 EDT 2018
In the subprocess doc for 3.7, the arguments shown for subprocess.run() don’t include the new capture_output parameter added in 3.7.
capture_output gets mentioned a few times in the .run section, but since it’s not listed in the argument list it makes things confusing while reading through it as to what it’s supposed to be. It has the italics of an argument, but not being in the list caused a lot of “wait, what are they talking about? It’s not an argument, so what did I miss?” confusion while reading the doc in order.
There is the comment that “The arguments shown above are merely the most common ones, described below in Frequently Used Arguments” However, immediately after that there is “most of the arguments to this function are passed through to that interface. (timeout, input, check, and capture_output are not.)” so it’s not mentioned further down in the doc in either Frequently Used Arguments or in Popen, only tiny notes in the “changed in version 3.7” and the .run example.
Simply adding capture_output with its default to the shown keyword arguments for .run() should be enough to eliminate the confusion.
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the docs