This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author terry.reedy
Recipients barry, docs@python, r.david.murray, sandro.tosi, terry.reedy
Date 2013-03-20.21:49:13
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1363816153.46.0.919369956059.issue15013@psf.upfronthosting.co.za>
In-reply-to
Content
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."
History
Date User Action Args
2013-03-20 21:49:13terry.reedysetrecipients: + terry.reedy, barry, r.david.murray, sandro.tosi, docs@python
2013-03-20 21:49:13terry.reedysetmessageid: <1363816153.46.0.919369956059.issue15013@psf.upfronthosting.co.za>
2013-03-20 21:49:13terry.reedylinkissue15013 messages
2013-03-20 21:49:13terry.reedycreate