summaryrefslogtreecommitdiff
path: root/docs/library/ussl.rst
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-02-27 22:03:52 -0500
committerGitHub <noreply@github.com>2018-02-27 22:03:52 -0500
commit568c04e6afa8016062f685b2198c0209f62827f4 (patch)
treed07b76119f715add462983b335797adf64b61249 /docs/library/ussl.rst
parent6a2379fd0bfe10017d8abc5c36ef1d470c0d9b27 (diff)
parentea633117d01d94e8d56ed94344e4b3e46b4eef03 (diff)
Merge pull request #650 from tannewt/merge_2x3.0.0-alpha.2
Merge in commits from 2.x branch.
Diffstat (limited to 'docs/library/ussl.rst')
-rw-r--r--docs/library/ussl.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/library/ussl.rst b/docs/library/ussl.rst
index 3ec609f67..34db3151d 100644
--- a/docs/library/ussl.rst
+++ b/docs/library/ussl.rst
@@ -1,10 +1,12 @@
:mod:`ussl` -- SSL/TLS module
=============================
+.. include:: ../templates/unsupported_in_circuitpython.inc
+
.. module:: ussl
:synopsis: TLS/SSL wrapper for socket objects
-|see_cpython_module| :mod:`python:ssl`.
+|see_cpython_module| :mod:`cpython:ssl`.
This module provides access to Transport Layer Security (previously and
widely known as “Secure Sockets Layer”) encryption and peer authentication
@@ -18,13 +20,13 @@ Functions
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
- socket interface and methods like `recv()`, `send()`. In particular, a
+ ``read()``, ``write()``, etc. In MicroPython, the returned object does not expose
+ socket interface and methods like ``recv()``, ``send()``. In particular, a
server-side SSL socket should be created from a normal socket returned from
`accept()` on a non-SSL listening server socket.
Depending on the underlying module implementation in a particular
- `MicroPython port`, some or all keyword arguments above may be not supported.
+ ``MicroPython port``, some or all keyword arguments above may be not supported.
.. warning::