Skip to content

bpo-36165 Fix rst formatting for several links in ssl documentation #13133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lisroach merged 1 commit into from
May 6, 2019
Merged

bpo-36165 Fix rst formatting for several links in ssl documentation #13133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix rst formatting for several links in ssl documentation 
* The formatting for ssl.PROTOCOL_SSLv23 and ssl.SSLContext.wrap_bio was
  missing a colon so they weren't properly formatted as links.

* Corrected link SSLContext.wrap_socket() to be singular instead of plural

Fixes https://bugs.python.org/issue36165
  • Loading branch information
@abadger
abadger committed May 6, 2019
commit 4033b24b08f8b39668b695686b89e0ef243f1001
6 changes: 3 additions & 3 deletions Doc/library/ssl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ Constants

.. data:: PROTOCOL_SSLv23

Alias for data:`PROTOCOL_TLS`.
Alias for :data:`PROTOCOL_TLS`.

.. deprecated:: 3.6

Expand Down Expand Up @@ -1821,7 +1821,7 @@ to speed up repeated connections from the same clients.

.. attribute:: SSLContext.sslsocket_class

The return type of :meth:`SSLContext.wrap_sockets`, defaults to
The return type of :meth:`SSLContext.wrap_socket`, defaults to
:class:`SSLSocket`. The attribute can be overridden on instance of class
in order to return a custom subclass of :class:`SSLSocket`.

Expand All @@ -1831,7 +1831,7 @@ to speed up repeated connections from the same clients.
server_hostname=None, session=None)

Wrap the BIO objects *incoming* and *outgoing* and return an instance of
attr:`SSLContext.sslobject_class` (default :class:`SSLObject`). The SSL
:attr:`SSLContext.sslobject_class` (default :class:`SSLObject`). The SSL
routines will read input data from the incoming BIO and write data to the
outgoing BIO.

Expand Down