[issue4488] Python Documentation not Newb Friendly

[Terry J. Reedy]

Terry J. Reedy <tjreedy at udel.edu> added the comment:

Yes, the new docs are much better.  Methods are nicely identified in
2.6/3.0 docs that I checked.  There is one category that is not:
constants.  For instance, the following is from the subprocess doc.

"stdin, stdout and stderr specify the executed programs’ standard input,
standard output and standard error file handles, respectively. Valid
values are PIPE, an existing file descriptor (a positive integer), an
existing file object, and None. PIPE indicates that a new pipe to the
child should be created. With None, no redirection will occur; the
child’s file handles will be inherited from the parent. Additionally,
stderr can be STDOUT, which indicates that the stderr data from the
applications should be captured into the same file handle as for stdout."

As I discovered, neither 'PIPE' nor PIPE is valid, subprocess.PIPE is
what is required.  (Ditto for subprocess.STDOUT I presume.) Can such
names of constants be fully qualified just as method names are now?

----------
nosy: +tjreedy

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