[tor-commits] [stem/master] Adding missing funtion to hearder doc

atagar at torproject.org atagar at torproject.org
Mon Apr 16 01:37:20 UTC 2012


commit a534c0607139ac9250243673d081c790866abc48
Author: Damian Johnson <atagar at torproject.org>
Date:   Sun Apr 15 16:34:57 2012 -0700

    Adding missing funtion to hearder doc
    
    The ControlSocket was missing an entry in its header docs for __enter__ and
    __exit__.
---
 stem/socket.py |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/stem/socket.py b/stem/socket.py
index 6714f63..55129f3 100644
--- a/stem/socket.py
+++ b/stem/socket.py
@@ -15,7 +15,8 @@ ControlSocket - Socket wrapper that speaks the tor control protocol.
   |- recv - receives a ControlMessage from the socket
   |- is_alive - reports if the socket is known to be closed
   |- connect - connects a new socket
-  +- close - shuts down the socket
+  |- close - shuts down the socket
+  +- __enter__ / __exit__ - manages socket connection
 
 ControlMessage - Message that's read from the control socket.
   |- content - provides the parsed message content





More information about the tor-commits mailing list