[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-25 Thread Martin Panter
Changes by Martin Panter : -- resolution: -> fixed stage: commit review -> resolved status: open -> closed ___ Python tracker ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-25 Thread Roundup Robot
Roundup Robot added the comment: New changeset 720865fa61a4 by Martin Panter in branch '3.5': Issue #26240: Clean up the subprocess module doc string https://hg.python.org/cpython/rev/720865fa61a4 New changeset 8358c68579e9 by Martin Panter in branch '3.6': Issue #26240: Merge subprocess doc

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-21 Thread Martin Panter
Changes by Martin Panter : Added file: http://bugs.python.org/file45180/subprocess3-2.7.patch ___ Python tracker ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-21 Thread Martin Panter
Martin Panter added the comment: Here are corresponding patches for 3.5 and 2.7. -- stage: patch review -> commit review Added file: http://bugs.python.org/file45179/subprocess3-3.5.patch ___ Python tracker

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-20 Thread Martin Panter
Martin Panter added the comment: V3 looks good to me -- ___ Python tracker ___ ___ Python-bugs-list mailing

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-20 Thread Tim Mitchell
Tim Mitchell added the comment: Changes as per Martins review. -- Added file: http://bugs.python.org/file45159/subprocess3.patch ___ Python tracker ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-19 Thread Martin Panter
Martin Panter added the comment: . I left some comments on the code review. Also, I’m not sure about the links to the online documentation. We don’t do this for other modules as far as I know. The pydoc module and help() commands already add their own links, which can be configured via

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-18 Thread Tim Mitchell
Tim Mitchell added the comment: Am now working from tip of default in mercurial (Python 3.6). * Removed all changes to subprocess.rst. subprocess.__doc__ * Trimmed down even further - removed function signatures. * added note to see Python docs for complete description. Exception docs * just

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-18 Thread Martin Panter
Martin Panter added the comment: Thanks for tackling this one Tim. I agree with Berker that the :const:`True` changes are out of scope (some introduce errors and inaccuracies). class CalledProcessError(SubprocessError): -"""Raised when a check_call() or check_output() process returns

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-18 Thread Tim Mitchell
Tim Mitchell added the comment: hg patch with changes forthcoming -- ___ Python tracker ___ ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-17 Thread Antony Lee
Changes by Antony Lee : -- nosy: -Antony.Lee ___ Python tracker ___ ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-17 Thread Berker Peksag
Berker Peksag added the comment: Thanks for the patch, Tim. > Changed true -> :const:`True` in subprocess.rst. This is out of scope for this issue and I actually prefer the current form. Having method and class signatures in subprocess.__doc__ would make it less maintainable. I'd prefer

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-17 Thread Berker Peksag
Changes by Berker Peksag : -- nosy: +berker.peksag stage: needs patch -> patch review versions: +Python 3.7 ___ Python tracker

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-17 Thread Tim Mitchell
Tim Mitchell added the comment: Have stripped down the module __doc__ to a list of contents. I chose to indent the descriptions of each argument to Popen. I know this is non-standard but it is such a long ramble otherwise. Changed true -> :const:`True` in subprocess.rst. -- keywords:

[issue26240] Docstring of the subprocess module should be cleaned up

2016-10-03 Thread Mariatta Wijaya
Changes by Mariatta Wijaya : -- nosy: +Mariatta ___ Python tracker ___ ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-09-12 Thread Robert Collins
Changes by Robert Collins : -- nosy: +rbcollins ___ Python tracker ___ ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-03-19 Thread Ezio Melotti
Changes by Ezio Melotti : -- keywords: +easy nosy: +ezio.melotti type: -> enhancement ___ Python tracker ___

[issue26240] Docstring of the subprocess module should be cleaned up

2016-02-05 Thread Terry J. Reedy
Terry J. Reedy added the comment: I agree. The module docstring should briefly describe the module and maybe list the contents, a line for each. The itertools docstring does the latter; the math docstring does not, though I would not mind if it did. -- nosy: +terry.reedy

[issue26240] Docstring of the subprocess module should be cleaned up

2016-01-29 Thread Martin Panter
Martin Panter added the comment: IMO the doc strings should be reduced down so that it is a concise summary, and divided or merged into doc strings of each class, method, function. Less important details should be moved to the main RST documentation (if they aren’t already there). Regarding

[issue26240] Docstring of the subprocess module should be cleaned up

2016-01-29 Thread Antony Lee
New submission from Antony Lee: subprocess.__doc__ currently contains copies for the docstrings of a bunch of functions in the module (... but not subprocess.run). The docs for the Popen class should be moved into that class' docstring. The module's docstring also mentions the list2cmdline