[docs] Description of 'secure' argument for logging.handlers.SMTPHandler isn't up to date

Jesaja Everling jeverling at gmail.com
Fri Jul 22 18:12:30 CEST 2011


Hi,

the docs for logging.handlers.SMTPHandler are not up to date.

Docs:
http://docs.python.org/library/logging.handlers.html#logging.handlers.SMTPHandler

"If secure is True, then the handler will attempt to use TLS for the
email transmission.".


Docstring:
http://hg.python.org/cpython/file/c6e63c67efd5/Lib/logging/handlers.py#l833

"To specify the use of a secure protocol (TLS), pass in a tuple for
the secure argument.
This will only be used when authentication credentials are supplied.
The tuple will be either an empty tuple, or a single-value tuple with
the name of a keyfile,
or a 2-value tuple with the names of the keyfile and certificate file.
(This tuple is passed to the `starttls` method)."

Just in case nobody noticed this before.

Best Regards,

Jesaja Everling


More information about the docs mailing list