[Python-checkins] gh-101879: docs - italicize argument in smtplib.SMPT() description (#101886)
erlend-aasland
webhook-mailer at python.org
Wed Apr 26 15:00:26 EDT 2023
https://github.com/python/cpython/commit/28a05f4cc2b150b3ff02ec255daf1b6ec886ca6f
commit: 28a05f4cc2b150b3ff02ec255daf1b6ec886ca6f
branch: main
author: Owain Davies <116417456+OTheDev at users.noreply.github.com>
committer: erlend-aasland <erlend.aasland at protonmail.com>
date: 2023-04-26T21:00:19+02:00
summary:
gh-101879: docs - italicize argument in smtplib.SMPT() description (#101886)
files:
M Doc/library/smtplib.rst
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst
index 2539c3d38832..4686232b09ac 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.
More information about the Python-checkins
mailing list