summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/ssl.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index ecafbef..2ab29fd 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -600,7 +600,9 @@ Connection objects have the following methods:
.. py:method:: Connection.get_protocol_version()
- Retrieve the version of the SSL or TLS protocol used by the Connection
+ Retrieve the version of the SSL or TLS protocol used by the Connection. For
+ example, it will return ``TLSv1`` for connections made over TLS version 1, or
+ ``Unknown`` for connections that were not successfully established.
.. py:method:: Connection.get_client_ca_list()