summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorJim Shaver <dcypherd@gmail.com>2015-04-27 00:48:25 -0400
committerJim Shaver <dcypherd@gmail.com>2015-05-27 17:39:56 -0400
commit3cd0e672f930ff34b76cbf35893ca1d9a0b70f9d (patch)
treefb2b4c846aa93c96a0ed95f80a5927bf4d872a0d /doc/api
parent2637c3b753c1807b55accb7d8fc2e99a9e9bb926 (diff)
downloadpyopenssl-git-3cd0e672f930ff34b76cbf35893ca1d9a0b70f9d.tar.gz
Added example and cleanup to doc/api
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()