1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

gh-101879: docs - italicize argument in smtplib.SMPT() description (#101886)

Browse Source
This commit is contained in:
Owain Davies 2023-04-27 02:00:19 +07:00 committed by GitHub
parent 37e37553b0
commit 28a05f4cc2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/smtplib.rst
View File

@ -25,7 +25,7 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
An :class:`SMTP` instance encapsulates an SMTP connection. It has methods An :class:`SMTP` instance encapsulates an SMTP connection. It has methods
that support a full repertoire of SMTP and ESMTP operations. If the optional that support a full repertoire of SMTP and ESMTP operations. If the optional
host and port parameters are given, the SMTP :meth:`connect` method is *host* and *port* parameters are given, the SMTP :meth:`connect` method is
called with those parameters during initialization. If specified, called with those parameters during initialization. If specified,
*local_hostname* is used as the FQDN of the local host in the HELO/EHLO *local_hostname* is used as the FQDN of the local host in the HELO/EHLO
command. Otherwise, the local hostname is found using command. Otherwise, the local hostname is found using
@ -34,12 +34,12 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
*timeout* parameter specifies a timeout in seconds for blocking operations *timeout* parameter specifies a timeout in seconds for blocking operations
like the connection attempt (if not specified, the global default timeout like the connection attempt (if not specified, the global default timeout
setting will be used). If the timeout expires, :exc:`TimeoutError` is setting will be used). If the timeout expires, :exc:`TimeoutError` is
raised. The optional source_address parameter allows binding raised. The optional *source_address* parameter allows binding
to some specific source address in a machine with multiple network to some specific source address in a machine with multiple network
interfaces, and/or to some specific source TCP port. It takes a 2-tuple interfaces, and/or to some specific source TCP port. It takes a 2-tuple
(host, port), for the socket to bind to as its source address before ``(host, port)``, for the socket to bind to as its source address before
connecting. If omitted (or if host or port are ``''`` and/or 0 respectively) connecting. If omitted (or if *host* or *port* are ``''`` and/or ``0``
the OS default behavior will be used. respectively) the OS default behavior will be used.
For normal use, you should only require the initialization/connect, For normal use, you should only require the initialization/connect,
:meth:`sendmail`, and :meth:`SMTP.quit` methods. :meth:`sendmail`, and :meth:`SMTP.quit` methods.