[tor-commits] [stem/master] Fix controller sphinx errors

atagar at torproject.org atagar at torproject.org
Tue Dec 12 20:00:23 UTC 2017


commit a53ec0cddde92aab452664f3824fa3e9217ea50d
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Dec 12 11:57:57 2017 -0800

    Fix controller sphinx errors
    
    Couple formatting errors that caused our docs to be malformed...
    
      /home/atagar/Desktop/stem/stem/control.py:docstring of stem.control.CreateHiddenServiceOutput:12: WARNING: Definition list ends without a blank line; unexpected unindent.
      /home/atagar/Desktop/stem/stem/control.py:docstring of stem.control.Controller.create_ephemeral_hidden_service:45: WARNING: Definition list ends without a blank line; unexpected unindent.
---
 stem/control.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/stem/control.py b/stem/control.py
index 1b719dd0..a4297677 100644
--- a/stem/control.py
+++ b/stem/control.py
@@ -453,7 +453,7 @@ class CreateHiddenServiceOutput(collections.namedtuple('CreateHiddenServiceOutpu
 
   :var str path: hidden service directory
   :var str hostname: content of the hostname file if available
-  :var dict hostname_for_client:mapping of client names to their onion address
+  :var dict hostname_for_client: mapping of client names to their onion address
     if available
   :var dict config: tor's new hidden service configuration
   """
@@ -2847,6 +2847,8 @@ class Controller(BaseController):
     ... while both alice and bob can access with existing credentials in the
     following...
 
+    ::
+
       controller.create_ephemeral_hidden_service(80, basic_auth = {
         'alice': 'l4BT016McqV2Oail+Bwe6w',
         'bob': 'vGnNRpWYiMBFTWD2gbBlcA',



More information about the tor-commits mailing list