]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101879: docs - italicize argument in smtplib.SMPT() description (#101886)
authorOwain Davies <116417456+OTheDev@users.noreply.github.com>
Wed, 26 Apr 2023 19:00:19 +0000 (02:00 +0700)
committerGitHub <noreply@github.com>
Wed, 26 Apr 2023 19:00:19 +0000 (21:00 +0200)
Doc/library/smtplib.rst

index 2539c3d388329831039e4b722bc9ab4ece7fb1fe..4686232b09ac47d7c07895249563b3bf13cb23e4 100644 (file)
@@ -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.