You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2012/10/22 20:44:09 UTC
svn commit: r1400996 -
/libcloud/site/trunk/content/docstring-conventions.mdtext
Author: tomaz
Date: Mon Oct 22 18:44:09 2012
New Revision: 1400996
URL: http://svn.apache.org/viewvc?rev=1400996&view=rev
Log:
CMS commit to libcloud by tomaz
Modified:
libcloud/site/trunk/content/docstring-conventions.mdtext
Modified: libcloud/site/trunk/content/docstring-conventions.mdtext
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/docstring-conventions.mdtext?rev=1400996&r1=1400995&r2=1400996&view=diff
==============================================================================
--- libcloud/site/trunk/content/docstring-conventions.mdtext (original)
+++ libcloud/site/trunk/content/docstring-conventions.mdtext Mon Oct 22 18:44:09 2012
@@ -28,41 +28,39 @@ This field should be added before the ar
For example:
-```python
-class NodeDriver(BaseDriver):
- def create_node(self, **kwargs):
- """
- Create a new node instance.
-
- @keyword name: String with a name for this new node (required)
- @type name: C{str}
-
- @return: The newly created node.
- @rtype: L{Node}
- """
- pass
-
- def deploy_node(self, **kwargs):
- """
- Create a new node, and start deployment.
-
- @inherits: L{NodeDriver.create_node}
-
- @keyword deploy: Deployment to run once machine is online and
- availble to SSH.
- @type deploy: L{Deployment}
- """
- pass
-```
-
-```python
-class OpenStackNodeDriver(NodeDriver):
- def create_node(self, **kwargs):
- """
- @inherits: L{NodeDriver.create_node}
-
- @keyword ex_metadata: Key/Value metadata to associate with a node
- @type ex_metadata: C{dict}
- """
- pass
-```
+ ::python
+ class NodeDriver(BaseDriver):
+ def create_node(self, **kwargs):
+ """
+ Create a new node instance.
+
+ @keyword name: String with a name for this new node (required)
+ @type name: C{str}
+
+ @return: The newly created node.
+ @rtype: L{Node}
+ """
+ pass
+
+ def deploy_node(self, **kwargs):
+ """
+ Create a new node, and start deployment.
+
+ @inherits: L{NodeDriver.create_node}
+
+ @keyword deploy: Deployment to run once machine is online and
+ availble to SSH.
+ @type deploy: L{Deployment}
+ """
+ pass
+
+ ::python
+ class OpenStackNodeDriver(NodeDriver):
+ def create_node(self, **kwargs):
+ """
+ @inherits: L{NodeDriver.create_node}
+
+ @keyword ex_metadata: Key/Value metadata to associate with a node
+ @type ex_metadata: C{dict}
+ """
+ pass
\ No newline at end of file