summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/ussl.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/ussl.rst')
-rw-r--r--docs/library/ussl.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/library/ussl.rst b/docs/library/ussl.rst
index 36f6d65a4a..c71b283ccb 100644
--- a/docs/library/ussl.rst
+++ b/docs/library/ussl.rst
@@ -4,6 +4,8 @@
.. module:: ussl
:synopsis: TLS/SSL wrapper for socket objects
+|see_cpython_module| :mod:`python:ssl`.
+
This module provides access to Transport Layer Security (previously and
widely known as “Secure Sockets Layer”) encryption and peer authentication
facilities for network sockets, both client-side and server-side.
@@ -13,7 +15,7 @@ Functions
.. function:: ssl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
- Takes a stream `sock` (usually usocket.socket instance of ``SOCK_STREAM`` type),
+ Takes a stream *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
and returns an instance of ssl.SSLSocket, which wraps the underlying stream in
an SSL context. Returned object has the usual stream interface methods like
`read()`, `write()`, etc. In MicroPython, the returned object does not expose
@@ -43,4 +45,4 @@ Constants
ssl.CERT_OPTIONAL
ssl.CERT_REQUIRED
- Supported values for `cert_reqs` parameter.
+ Supported values for *cert_reqs* parameter.