[docs] [issue15013] smtplib: add low-level APIs to doc?

Terry J. Reedy report at bugs.python.org
Wed Mar 20 22:49:13 CET 2013

Terry J. Reedy added the comment:

By current standards, we normally document all public methods. 

.rset() and .noop() are trivial, "same as .docmd('funcname')"

.help() is almost trivial, just removing the first field of the reply (I assume a return code). 'returns message part of .putcmd('help')"

.mail(s, options) and .rcpt(r, options) are not so trivial. Explaining the possible options, I presume defined in the rfcs and used elsewhere by other methods, seems beyond the scope of the docs. "Open mail session; for *options* list, see RFCs" might be a possible entry.

.data(msg) also seems complicated in its details. I can see why the author left out such minutia for something that normally should not be called. I would be inclined to just say "Send message to server; see docstring for details."

nosy: +terry.reedy

Python tracker <report at bugs.python.org>

More information about the docs mailing list