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

Martin Panter report at bugs.python.org
Sat Jan 30 02:02:34 EST 2016


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 list2cmdline(), see the comment next to __all__ in the source code, and Issue 11827. BTW modifying __all__ would not automatically affect what is written in the RST files, which is where the “official” HTML docs come from :)

----------
nosy: +martin.panter
stage:  -> needs patch
versions: +Python 2.7, Python 3.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue26240>
_______________________________________


More information about the docs mailing list