Skip to content
Snippets Groups Projects
Commit d4fa787d authored by Brandon Wiley's avatar Brandon Wiley
Browse files

Fixed indentdation of documentation strings

parent 60c86ada
No related branches found
No related tags found
No related merge requests found
......@@ -14,17 +14,17 @@ __docformat__ = 'restructuredtext'
class ClientConfig(Config):
"""
"""
The ClientConfig class contains a low-level API which closely follows the Tor Proposal 180: Pluggable transports for circumvention.
This class inherits from pyptlib.config.Config and contains just the parts of the API which are specific to the client implementations of the protocol.
"""
"""
# Public methods
def __init__(self): # throws EnvError
"""
Initialize the ClientConfig object.
This causes the state location, managed transport, and transports version to be set.
Initialize the ClientConfig object.
This causes the state location, managed transport, and transports version to be set.
"""
Config.__init__(self)
......@@ -49,8 +49,8 @@ class ClientConfig(Config):
optArgs,
):
"""
Write a message to stdout specifying a supported transport
Takes: str, int, (str, int), [str], [str]
Write a message to stdout specifying a supported transport
Takes: str, int, (str, int), [str], [str]
"""
methodLine = 'CMETHOD %s socks%s %s:%s' % (name, socksVersion,
......@@ -63,8 +63,8 @@ class ClientConfig(Config):
def writeMethodError(self, name, message): # CMETHOD-ERROR
"""
Write a message to stdout specifying that an error occurred setting up the specified method
Takes: str, str
Write a message to stdout specifying that an error occurred setting up the specified method
Takes: str, str
"""
self.emit('CMETHOD-ERROR %s %s' % (name, message))
......
......@@ -13,10 +13,10 @@ __docformat__ = 'restructuredtext'
class Config:
"""
"""
The Config module class a low-level API which closely follows the Tor Proposal 180: Pluggable transports for circumvention.
This class contains the parts of the API which are shared by both client and server implementations of the protocol.
"""
"""
stateLocation = None # TOR_PT_STATE_LOCATION
managedTransportVer = [] # TOR_PT_MANAGED_TRANSPORT_VER
transports = [] # TOR_PT_SERVER_TRANSPORTS or TOR_PT_CLIENT_TRANSPORTS
......
......@@ -14,10 +14,10 @@ __docformat__ = 'restructuredtext'
class ServerConfig(Config):
"""
"""
The ServerConfig class contains a low-level API which closely follows the Tor Proposal 180: Pluggable transports for circumvention.
This class inherits from pyptlib.config.Config and contains just the parts of the API which are specific to the client implementations of the protocol.
"""
"""
extendedServerPort = None # TOR_PT_EXTENDED_SERVER_PORT
ORPort = None # TOR_PT_ORPORT
serverBindAddr = {} # TOR_PT_SERVER_BINADDR
......@@ -84,15 +84,15 @@ class ServerConfig(Config):
self.emit('SMETHOD %s %s:%s' % (name, address[0], address[1]))
def writeMethodError(self, name, message): # SMETHOD-ERROR
"""
Write a message to stdout specifying that an error occurred setting up the specified method
Takes: str, str
"""
"""
Write a message to stdout specifying that an error occurred setting up the specified method
Takes: str, str
"""
self.emit('SMETHOD-ERROR %s %s' % (name, message))
def writeMethodEnd(self): # SMETHODS DONE
""" Write a message to stdout specifying that the list of supported transports has ended """
""" Write a message to stdout specifying that the list of supported transports has ended """
self.emit('SMETHODS DONE')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment