diff options
| author | Owain Davies <116417456+OTheDev@users.noreply.github.com> | 2023-04-26 19:00:19 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-26 19:00:19 (GMT) |
| commit | 28a05f4cc2b150b3ff02ec255daf1b6ec886ca6f (patch) | |
| tree | f3354419d20f0a82675976c5d6ae9302e155c81b | |
| parent | 37e37553b09dba073cfe77d9fb96863b94df2fbc (diff) | |
| download | cpython-28a05f4cc2b150b3ff02ec255daf1b6ec886ca6f.zip cpython-28a05f4cc2b150b3ff02ec255daf1b6ec886ca6f.tar.gz cpython-28a05f4cc2b150b3ff02ec255daf1b6ec886ca6f.tar.bz2 | |
gh-101879: docs - italicize argument in smtplib.SMPT() description (#101886)
| -rw-r--r-- | Doc/library/smtplib.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 2539c3d..4686232 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -25,7 +25,7 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions). An :class:`SMTP` instance encapsulates an SMTP connection. It has methods 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, *local_hostname* is used as the FQDN of the local host in the HELO/EHLO 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 like the connection attempt (if not specified, the global default timeout 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 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 - connecting. If omitted (or if host or port are ``''`` and/or 0 respectively) - the OS default behavior will be used. + ``(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) the OS default behavior will be used. For normal use, you should only require the initialization/connect, :meth:`sendmail`, and :meth:`SMTP.quit` methods. |