[tor-commits] [stem/master] Fix Controller.get_conf_map's documentation formatting

atagar at torproject.org atagar at torproject.org
Sun Jul 8 20:14:44 UTC 2012


commit 0bfa815f85337cbd216d0fbb2965b6ab305d3874
Author: Ravi Chandra Padmala <neenaoffline at gmail.com>
Date:   Mon Jul 2 22:48:09 2012 +0530

    Fix Controller.get_conf_map's documentation formatting
---
 stem/control.py |    8 +++-----
 1 files changed, 3 insertions(+), 5 deletions(-)

diff --git a/stem/control.py b/stem/control.py
index 5fce8c8..5e88ef5 100644
--- a/stem/control.py
+++ b/stem/control.py
@@ -591,11 +591,9 @@ class Controller(BaseController):
     only whitespace are ignored.
     
     There's three use cases for GETCONF:
-    - a single value is provided
-    - multiple values are provided for the option queried
-    - a set of options that weren't necessarily requested are returned (for
-      instance querying HiddenServiceOptions gives HiddenServiceDir,
-      HiddenServicePort, etc)
+      1. a single value is provided
+      2. multiple values are provided for the option queried
+      3. a set of options that weren't necessarily requested are returned (for instance querying HiddenServiceOptions gives HiddenServiceDir, HiddenServicePort, etc)
     
     The vast majority of the options fall into the first two categories, in
     which case calling get_conf() is sufficient. However, for batch queries or





More information about the tor-commits mailing list