diff options
| author | Steve Dower <steve.dower@python.org> | 2019-06-27 17:47:59 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-27 17:47:59 (GMT) |
| commit | 44f91c388a6f4da9ed3300df32ca290b8aa104ea (patch) | |
| tree | 6e02d501dbcb28708fa662a33da2715a505389e5 /Doc/library/smtplib.rst | |
| parent | 21cfae107e410bf4b0ab3c142ca4449bc33290f5 (diff) | |
| download | cpython-44f91c388a6f4da9ed3300df32ca290b8aa104ea.zip cpython-44f91c388a6f4da9ed3300df32ca290b8aa104ea.tar.gz cpython-44f91c388a6f4da9ed3300df32ca290b8aa104ea.tar.bz2 | |
bpo-37390: Add audit event table to documentations (GH-14406)
Also updates some (unreleased) event names to be consistent with the others.
Diffstat (limited to 'Doc/library/smtplib.rst')
| -rw-r--r-- | Doc/library/smtplib.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 8771f10..6176c35 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -55,9 +55,11 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions). (250, b'Ok') >>> - All commands will raise an :ref:`auditing event <auditing>` - ``smtplib.SMTP.send`` with arguments ``self`` and ``data``, - where ``data`` is the bytes about to be sent to the remote host. + .. audit-event:: smtplib.send self,data smtplib.SMTP + + All commands will raise an :ref:`auditing event <auditing>` + ``smtplib.SMTP.send`` with arguments ``self`` and ``data``, + where ``data`` is the bytes about to be sent to the remote host. .. versionchanged:: 3.3 Support for the :keyword:`with` statement was added. @@ -246,7 +248,7 @@ An :class:`SMTP` instance has the following methods: 2-tuple of the response code and message sent by the server in its connection response. - .. audit-event:: smtplib.SMTP.connect "self host port" + .. audit-event:: smtplib.connect self,host,port smtplib.SMTP.connect .. method:: SMTP.helo(name='') |