bpo-30420: Document the cwd argument to check_output and check_call #1685
Conversation
|
@alex, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @gpshead and @ncoghlan to be potential reviewers. |
|
There are other parameters missing compared to Popen, which is already mentioned in the documentation. Perhaps it would be better to add an ellipsis (...) or **params at the end of the signature to make this more obvious. |
|
It's possible there are larger-scale changes that would be preferable. This was inspired by me using this parameter in some code, and @reaperhulk being skeptical that the parameter existed because it wasn't documented. This PR solves that problem, not broader challenges. |
|
+1 for adding In addition to Regarding the general concern, I started writing a longer reply here, and then realised I would be better off just filing an issue and posting the relevant details there: http://bugs.python.org/issue30420 Basically, I think we have pretty solid (albeit anecdotal) evidence that our current approach to making these docs less overwhelming is genuinely misleading people as to the available API options, and we need to tweak things accordingly. |
|
@ncoghlan good call (pun intended) on |
|
This at least makes it clearer that |
|
Sounds good. |
…ythonGH-1685) Partially clarify the subprocess convenience API documentation by explicitly listing the `cwd` parameter in their abbreviated signatures. While this has been merged as an improvement, it doesn't fully resolve the issue, as the `cwd` should also be covered in the "Frequently Used Arguments" section, and the fact these APIs pass unlisted keyword arguments down to the lower level APIs is currently still unclear. (cherry picked from commit 368cf1d)
|
GH-2253 is a backport of this pull request to the 3.6 branch |
…H-1685) (GH-2253) Partially clarify the subprocess convenience API documentation by explicitly listing the `cwd` parameter in their abbreviated signatures. While this has been merged as an improvement, it doesn't fully resolve the issue, as the `cwd` should also be covered in the "Frequently Used Arguments" section, and the fact these APIs pass unlisted keyword arguments down to the lower level APIs is currently still unclear. (cherry picked from commit 368cf1d)
No description provided.