You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by bu...@apache.org on 2012/10/22 20:44:15 UTC
svn commit: r835780 - in /websites/staging/libcloud/trunk/content: ./
docstring-conventions.html
Author: buildbot
Date: Mon Oct 22 18:44:15 2012
New Revision: 835780
Log:
Staging update by buildbot for libcloud
Modified:
websites/staging/libcloud/trunk/content/ (props changed)
websites/staging/libcloud/trunk/content/docstring-conventions.html
Propchange: websites/staging/libcloud/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Oct 22 18:44:15 2012
@@ -1 +1 @@
-1400993
+1400996
Modified: websites/staging/libcloud/trunk/content/docstring-conventions.html
==============================================================================
--- websites/staging/libcloud/trunk/content/docstring-conventions.html (original)
+++ websites/staging/libcloud/trunk/content/docstring-conventions.html Mon Oct 22 18:44:15 2012
@@ -120,47 +120,42 @@ For example: <code>@rtype: C{list} of L{
This field should be added before the arguments. If inherited docstring doesn't contain description\rtype, they used from the parent docstring.</li>
</ul>
<p>For example:</p>
-<p>```python
-class NodeDriver(BaseDriver):
- def create_node(self, **kwargs):
- """
- Create a new node instance.</p>
-<div class="codehilite"><pre> <span class="nv">@keyword</span> <span class="n">name:</span> <span class="n">String</span> <span class="n">with</span> <span class="n">a</span> <span class="n">name</span> <span class="k">for</span> <span class="n">this</span> <span class="k">new</span> <span class="n">node</span> <span class="p">(</span><span class="n">required</span><span class="p">)</span>
- <span class="nv">@type</span> <span class="n">name:</span> <span class="n">C</span><span class="p">{</span><span class="n">str</span><span class="p">}</span>
-
- <span class="nv">@return:</span> <span class="n">The</span> <span class="n">newly</span> <span class="n">created</span> <span class="n">node</span><span class="o">.</span>
- <span class="nv">@rtype:</span> <span class="n">L</span><span class="p">{</span><span class="n">Node</span><span class="p">}</span>
- <span class="s">"""</span>
-<span class="s"> pass</span>
-
-<span class="s"> def deploy_node(self, **kwargs):</span>
-<span class="s"> """</span>
- <span class="n">Create</span> <span class="n">a</span> <span class="k">new</span> <span class="n">node</span><span class="p">,</span> <span class="ow">and</span> <span class="n">start</span> <span class="n">deployment</span><span class="o">.</span>
-
- <span class="nv">@inherits:</span> <span class="n">L</span><span class="p">{</span><span class="n">NodeDriver</span><span class="o">.</span><span class="n">create_node</span><span class="p">}</span>
-
- <span class="nv">@keyword</span> <span class="n">deploy:</span> <span class="n">Deployment</span> <span class="n">to</span> <span class="n">run</span> <span class="n">once</span> <span class="n">machine</span> <span class="n">is</span> <span class="n">online</span> <span class="ow">and</span>
- <span class="n">availble</span> <span class="n">to</span> <span class="n">SSH</span><span class="o">.</span>
- <span class="nv">@type</span> <span class="n">deploy:</span> <span class="n">L</span><span class="p">{</span><span class="n">Deployment</span><span class="p">}</span>
- <span class="s">""</span><span class="err">"</span>
- <span class="n">pass</span>
+<div class="codehilite"><pre><span class="k">class</span> <span class="nc">NodeDriver</span><span class="p">(</span><span class="n">BaseDriver</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">create_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Create a new node instance.</span>
+
+<span class="sd"> @keyword name: String with a name for this new node (required)</span>
+<span class="sd"> @type name: C{str}</span>
+
+<span class="sd"> @return: The newly created node.</span>
+<span class="sd"> @rtype: L{Node}</span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
+
+ <span class="k">def</span> <span class="nf">deploy_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Create a new node, and start deployment.</span>
+
+<span class="sd"> @inherits: L{NodeDriver.create_node}</span>
+
+<span class="sd"> @keyword deploy: Deployment to run once machine is online and</span>
+<span class="sd"> availble to SSH.</span>
+<span class="sd"> @type deploy: L{Deployment}</span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
+
+<span class="p">::</span><span class="n">python</span>
+<span class="k">class</span> <span class="nc">OpenStackNodeDriver</span><span class="p">(</span><span class="n">NodeDriver</span><span class="p">):</span>
+ <span class="k">def</span> <span class="nf">create_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> @inherits: L{NodeDriver.create_node}</span>
+
+<span class="sd"> @keyword ex_metadata: Key/Value metadata to associate with a node</span>
+<span class="sd"> @type ex_metadata: C{dict}</span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
</pre></div>
-
-
-<p>```</p>
-<p>```python
-class OpenStackNodeDriver(NodeDriver):
- def create_node(self, **kwargs):
- """
- @inherits: L{NodeDriver.create_node}</p>
-<div class="codehilite"><pre> <span class="nv">@keyword</span> <span class="n">ex_metadata:</span> <span class="n">Key</span><span class="o">/</span><span class="n">Value</span> <span class="n">metadata</span> <span class="n">to</span> <span class="n">associate</span> <span class="n">with</span> <span class="n">a</span> <span class="n">node</span>
- <span class="nv">@type</span> <span class="n">ex_metadata:</span> <span class="n">C</span><span class="p">{</span><span class="n">dict</span><span class="p">}</span>
- <span class="s">""</span><span class="err">"</span>
- <span class="n">pass</span>
-</pre></div>
-
-
-<p>```</p>
</div>