Skip to content

Commit

Permalink
Added doc block for the constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
jgillmanjr committed Oct 20, 2014
1 parent 0eac68f commit 2aaf4ce
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions snakeStorm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ def listApiMethods(apiVersion = 'v1'):

class snakeStorm:

def __init__(self, username, password, method, parameters = {}, version = 'v1'):
def __init__(self, username, password, method, parameters = {}, version = 'v1'):
""" Instantiate the snakeStorm class. At a mininimum you'll need to specify the username, password, and method. """
self.username = username
self.password = password
self.method = method
Expand All @@ -43,11 +44,11 @@ def addParams(self, **params):
self.parameters[key] = value

def clearParams(self):
""" Remove all set parameters """
""" Remove all set parameters. """
self.parameters = {}

def listParams(self):
""" A holdover from me being used to having variable visibility """
""" A holdover from me being used to having variable visibility. """
return self.parameters

def removeParams(self, *params):
Expand All @@ -58,7 +59,7 @@ def removeParams(self, *params):

## API Interaction Methods ##
def request(self):
""" Send the request to the Storm API """
""" Send the request to the Storm API. """
## Do we have params or not? ##
if len(self.parameters) > 0:
self.postData['params'] = self.parameters
Expand Down

0 comments on commit 2aaf4ce

Please sign in to comment.