[tor-commits] [stem/master] Fix malformed table in convert() pydoc

atagar at torproject.org atagar at torproject.org
Mon Aug 17 00:53:02 UTC 2020


commit dd495b2673bba846f0963bd86edde48d83ed6793
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Aug 15 17:57:46 2020 -0700

    Fix malformed table in convert() pydoc
    
    Oops, while adjusting the indentation we broke this table for Sphinx...
    
      /home/atagar/Desktop/stem/stem/response/__init__.py:docstring of stem.response.convert:15: WARNING: Malformed table.
      Text in column margin in table line 10.
---
 stem/response/__init__.py | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/stem/response/__init__.py b/stem/response/__init__.py
index b4c7aed5..dafef71c 100644
--- a/stem/response/__init__.py
+++ b/stem/response/__init__.py
@@ -64,19 +64,19 @@ def convert(response_type: str, message: 'stem.response.ControlMessage', **kwarg
   :class:`~stem.response.ControlMessage` to a subclass for its response type.
   Recognized types include...
 
-  =================== =====
-  response_type       Class
-  =================== =====
-  **ADD_ONION**                :class:`stem.response.add_onion.AddOnionResponse`
-  **AUTHCHALLENGE**            :class:`stem.response.authchallenge.AuthChallengeResponse`
-  **EVENT**                    :class:`stem.response.events.Event` subclass
-  **GETCONF**                  :class:`stem.response.getconf.GetConfResponse`
-  **GETINFO**                  :class:`stem.response.getinfo.GetInfoResponse`
-  **MAPADDRESS**               :class:`stem.response.mapaddress.MapAddressResponse`
-  **ONION_CLIENT_AUTH_VIEW**   :class:`stem.response.onion_client_auth.OnionClientAuthViewResponse`
-  **PROTOCOLINFO**             :class:`stem.response.protocolinfo.ProtocolInfoResponse`
-  **SINGLELINE**               :class:`stem.response.SingleLineResponse`
-  =================== =====
+  =========================== =====
+  response_type               Class
+  =========================== =====
+  **ADD_ONION**               :class:`stem.response.add_onion.AddOnionResponse`
+  **AUTHCHALLENGE**           :class:`stem.response.authchallenge.AuthChallengeResponse`
+  **EVENT**                   :class:`stem.response.events.Event` subclass
+  **GETCONF**                 :class:`stem.response.getconf.GetConfResponse`
+  **GETINFO**                 :class:`stem.response.getinfo.GetInfoResponse`
+  **MAPADDRESS**              :class:`stem.response.mapaddress.MapAddressResponse`
+  **ONION_CLIENT_AUTH_VIEW**  :class:`stem.response.onion_client_auth.OnionClientAuthViewResponse`
+  **PROTOCOLINFO**            :class:`stem.response.protocolinfo.ProtocolInfoResponse`
+  **SINGLELINE**              :class:`stem.response.SingleLineResponse`
+  =========================== =====
 
   :param response_type: type of tor response to convert to
   :param message: message to be converted





More information about the tor-commits mailing list