[docs] [issue11260] smtpd-as-a-script feature should be documented and should use argparse

Raymond Hettinger report at bugs.python.org
Tue Feb 22 22:23:04 CET 2011


Raymond Hettinger <rhettinger at users.sourceforge.net> added the comment:

> As I said, my only intention here is be to document 
> (and argparsify/formalize) what is already there.

In a handful of cases, that would be useful; however,
for the most part, these APIs were undocumented for
a reason.  Some of the command-line interfaces were
slapped together without much of a design effort; some
were little more than quick-and-dirty ad-hoc tests.
It would be a mistake to "document and formalize"
accidental mini-apps.

There's no harm in adding --help or a usage example,
but please avoid making behavior guarantees that we
really don't want to have to live with.

Only "document and formalize" the parts that are well
thought out.

----------

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


More information about the docs mailing list