Author: tomaz
Date: Thu Feb 2 02:29:10 2012
New Revision: 1239442
URL: http://svn.apache.org/viewvc?rev=1239442&view=rev
Log:
Add missing docstrings to NodeDriver class. patch submitted by Shawn Smith and
is part of GH-57.
Modified:
libcloud/trunk/libcloud/compute/base.py
Modified: libcloud/trunk/libcloud/compute/base.py
URL:
http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/base.py?rev=1239442&r1=1239441&r2=1239442&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/base.py (original)
+++ libcloud/trunk/libcloud/compute/base.py Thu Feb 2 02:29:10 2012
@@ -428,6 +428,9 @@ class NodeDriver(BaseDriver):
Depending upon the provider, this may destroy all data associated with
the node, including backups.
+ @param node: The node to be destroyed
+ @type node: L{Node}
+
@return: C{bool} True if the destroy was successful, otherwise False
"""
raise NotImplementedError(
@@ -436,6 +439,10 @@ class NodeDriver(BaseDriver):
def reboot_node(self, node):
"""
Reboot a node.
+
+ @param node: The node to be rebooted
+ @type node: L{Node}
+
@return: C{bool} True if the reboot was successful, otherwise False
"""
raise NotImplementedError(
@@ -452,6 +459,10 @@ class NodeDriver(BaseDriver):
def list_images(self, location=None):
"""
List images on a provider
+
+ @keyword location: The location at which to list images
+ @type location: L{NodeLocation}
+
@return: C{list} of L{NodeImage} objects
"""
raise NotImplementedError(
@@ -460,6 +471,10 @@ class NodeDriver(BaseDriver):
def list_sizes(self, location=None):
"""
List sizes on a provider
+
+ @keyword location: The location at which to list sizes
+ @type location: L{NodeLocation}
+
@return: C{list} of L{NodeSize} objects
"""
raise NotImplementedError(
