Skip to content

Commit

Permalink
Update some docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
dnaeon committed Oct 8, 2013
1 parent 40abe30 commit cec8562
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/vmpoller-proxy
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ def start(pidfile, config, daemon):
"""
Start the VMPoller Proxy daemon
Args:
pidfile (string): Location to the daemon's pidfile
config (string): Configuration file of the VMPoller Proxy
daemon (bool): If True daemonize the VMPoller Proxy
"""
proxy = VMPollerProxy(pidfile)

Expand All @@ -54,6 +59,9 @@ def stop(endpoint):
"""
Stops the VMPoller Proxy daemon
Args:
endpoint (string): The endpoint we send the shutdown message to
"""
# The message we send to initiate the shutdown sequence
msg = { "cmd": "shutdown" }
Expand All @@ -68,6 +76,9 @@ def status(endpoint):
"""
Get status information from the VMPoller Proxy daemon
Args:
endpoint (string): The endpoint we send the status message to
"""
# The message we send to get status information
msg = { "cmd": "status" }
Expand Down
11 changes: 11 additions & 0 deletions src/vmpoller-worker
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ def start(pidfile, config, daemon):
"""
Start the VMPoller Worker daemon
Args:
pidfile (string): Location to the daemon's pidfile
config (string): Configuration file of the VMPoller Worker
daemon (bool): If True daemonize the VMPoller Worker
"""
worker = VMPollerWorker(pidfile)

Expand All @@ -57,6 +62,9 @@ def stop(endpoint):
"""
Stops the VMPoller Worker daemon
Args:
endpoint (string): The endpoint we send the shutdown message to
"""
# The message we send to initiate the shutdown sequence
msg = { "cmd": "shutdown" }
Expand All @@ -71,6 +79,9 @@ def status(endpoint):
"""
Get status information from the VMPoller Worker daemon
Args:
endpoint (string): The endpoint we send the status message to
"""
# The message we send to get status information
msg = { "cmd": "status" }
Expand Down

0 comments on commit cec8562

Please sign in to comment.