[New-bugs-announce] [issue15013] smtplib: add low-level APIs to doc?

Sandro Tosi report at bugs.python.org
Wed Jun 6 09:44:23 CEST 2012

New submission from Sandro Tosi <sandro.tosi at gmail.com>:

In the smtplib doc I read:

  Low-level methods corresponding to the standard SMTP/ESMTP commands HELP, RSET, NOOP, MAIL, RCPT, and DATA are also supported. Normally these do not need to be called directly, so they are not documented here. For details, consult the module code.

Well, I think the documentation should include also those low-level apis (maybe in a separate subsection).

>From my POV, smtplib should implement the protocol, and give the programmers the tools to use the protocol as they prefers, and as a plus some companion methods to easy the most common operations.

I'm in need to use the low-level apis, and not finding them in the doc is a disservice to me (with my user hat on ;)) and just say "go read the source" is kinda rude and unexpected.

What do you think?

assignee: docs at python
components: Documentation
messages: 162395
nosy: docs at python, sandro.tosi
priority: normal
severity: normal
stage: needs patch
status: open
title: smtplib: add low-level APIs to doc?
versions: Python 2.7, Python 3.2, Python 3.3

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list