[tor-commits] [stem/master] Revise stem.client docs

[atagar at torproject.org]

commit 7d33345426b54f0a55eb47163d207d0ce1cb3697
Author: Damian Johnson <atagar at torproject.org>
Date:   Thu Jan 18 09:58:11 2018 -0800

    Revise stem.client docs
    
    Not yet accurate, but the direction we're going.
---
 stem/client/__init__.py | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/stem/client/__init__.py b/stem/client/__init__.py
index 9ad790a8..d458e068 100644
--- a/stem/client/__init__.py
+++ b/stem/client/__init__.py
@@ -11,7 +11,13 @@ a wrapper for :class:`~stem.socket.RelaySocket`, much the same way as
 
 ::
 
-  Size - Packable and unpackable field size.
+  split - splits bytes into substrings
+
+  Field - Packable and unpackable datatype.
+    |- Size - Field of a static size.
+    |- Address - Relay address.
+    |- Certificate - Relay certificate.
+    |
     |- pack - encodes content
     |- unpack - decodes content
     +- pop - decodes content with remainder
@@ -30,6 +36,19 @@ a wrapper for :class:`~stem.socket.RelaySocket`, much the same way as
   **ERROR_PERMANENT**   permanent error retrieving address
   **UNKNOWN**           unrecognized address type
   ===================== ===========
+
+.. data:: CertType (enum)
+
+  Relay certificate type.
+
+  ===================== ===========
+  CertType              Description
+  ===================== ===========
+  **LINK**              link key certificate certified by RSA1024 identity
+  **IDENTITY**          RSA1024 Identity certificate
+  **AUTHENTICATE**      RSA1024 AUTHENTICATE cell link certificate
+  **UNKNOWN**           unrecognized certificate type
+  ===================== ===========
 """
 
 import collections