[issue9264] trace.py documentation is incomplete

Alexander Belopolsky report at bugs.python.org
Fri Aug 6 19:39:24 CEST 2010


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

The fixed up version is just r83549. It may merge cleanly with py3k - I believe doc changes are trivial if any between 2.6 and 3.x.

I would like this to go through another round of reviews without release calendar pressure.  I would like to see some guidelines for documenting command line options to stdlib modules.  In this particular patch, I don't like "Meta-options" sections.  No other module document has such section.  The --help and --version are not "meta-options", they are "common options". I would also like to see a mention that  one of --trace, --count, --report, --listfuncs, or --trackcalls must be specified.  (Even better would be to make one of these options the default behavior when no options are given.  Required option is an oxymoron.)

Terry,

This is in your hands now.  If you prefer to merge the change and postpone the improvements, it is fine with me.

----------
nosy: +georg.brandl

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


More information about the Python-bugs-list mailing list