diff options
Diffstat (limited to 'numpy/doc/html/example-module.html')
| -rw-r--r-- | numpy/doc/html/example-module.html | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/numpy/doc/html/example-module.html b/numpy/doc/html/example-module.html index 7a9fdfd5a..f08370632 100644 --- a/numpy/doc/html/example-module.html +++ b/numpy/doc/html/example-module.html @@ -56,12 +56,12 @@ <!-- ==================== MODULE DESCRIPTION ==================== --> <h1 class="epydoc">Module example</h1><p class="nomargin-top"><span class="codelink"><a href="example-pysrc.html">source code</a></span></p> <p>This is the docstring for the example.py module. Modules names should - have short, all-lowercase names. The module name may have underscores if - this improves readability.</p> - <p>Every module should have a docstring at the very top of the file. The - module's docstring may extend over multiple lines. If your docstring - does extend over multiple lines, the closing three quotation marks must - be on a line by itself, preferably preceeded by a blank line.</p> +have short, all-lowercase names. The module name may have underscores if +this improves readability.</p> +<p>Every module should have a docstring at the very top of the file. The +module's docstring may extend over multiple lines. If your docstring does +extend over multiple lines, the closing three quotation marks must be on +a line by itself, preferably preceeded by a blank line.</p> <!-- ==================== FUNCTIONS ==================== --> <a name="section-Functions"></a> @@ -168,61 +168,61 @@ </td> </tr></table> - <pre class="literalblock"> -One-line summary or signature. - -Several sentences providing an extended description. You can put -text in mono-spaced type like so: ``var``. - -Parameters ----------- -var1 : array_like - Array_like means all those objects -- lists, nested lists, etc. -- - that can be converted to an array. -var2 : integer - Write out the full type -long_variable_name : {'hi', 'ho'}, optional - Choices in brackets, default first when optional. - -Returns -------- -named : type - Explanation -list - Explanation -of - Explanation -outputs - even more explaining - -Other Parameters ----------------- -only_seldom_used_keywords : type - Explanation -common_parametrs_listed_above : type - Explanation - -See Also --------- -otherfunc : relationship (optional) -newfunc : relationship (optional) - -Notes ------ -Notes about the implementation algorithm (if needed). - -This can have multiple paragraphs as can all sections. - -Examples --------- - -examples in doctest format - ->>> a=[1,2,3] ->>> [x + 3 for x in a] -[4, 5, 6] - -</pre> + <p>One-line summary or signature.</p> +<p>Several sentences providing an extended description. You can put +text in mono-spaced type like so: <tt class="rst-docutils literal"><span class="pre">var</span></tt>.</p> +<div class="rst-section" id="rst-parameters"> +<h1 class="heading">Parameters</h1> +<dl class="rst-docutils"> +<dt>var1 <span class="classifier-delimiter">:</span> <span class="rst-classifier">array_like</span></dt> +<dd>Array_like means all those objects -- lists, nested lists, etc. -- +that can be converted to an array.</dd> +<dt>var2 <span class="classifier-delimiter">:</span> <span class="rst-classifier">integer</span></dt> +<dd>Write out the full type</dd> +<dt>long_variable_name <span class="classifier-delimiter">:</span> <span class="rst-classifier">{'hi', 'ho'}, optional</span></dt> +<dd>Choices in brackets, default first when optional.</dd> +</dl> +</div> +<div class="rst-section" id="rst-returns"> +<h1 class="heading">Returns</h1> +<dl class="rst-docutils"> +<dt>named <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt> +<dd>Explanation</dd> +<dt>list</dt> +<dd>Explanation</dd> +<dt>of</dt> +<dd>Explanation</dd> +<dt>outputs</dt> +<dd>even more explaining</dd> +</dl> +</div> +<div class="rst-section" id="rst-other-parameters"> +<h1 class="heading">Other Parameters</h1> +<dl class="rst-docutils"> +<dt>only_seldom_used_keywords <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt> +<dd>Explanation</dd> +<dt>common_parametrs_listed_above <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt> +<dd>Explanation</dd> +</dl> +</div> +<div class="rst-section" id="rst-see-also"> +<h1 class="heading">See Also</h1> +<p>otherfunc : relationship (optional) +newfunc : relationship (optional)</p> +</div> +<div class="rst-section" id="rst-notes"> +<h1 class="heading">Notes</h1> +<p>Notes about the implementation algorithm (if needed).</p> +<p>This can have multiple paragraphs as can all sections.</p> +</div> +<div class="rst-section" id="rst-examples"> +<h1 class="heading">Examples</h1> +<p>examples in doctest format</p> +<pre class="py-doctest"> +<span class="py-prompt">>>> </span>a=[1,2,3] +<span class="py-prompt">>>> </span>[x + 3 <span class="py-keyword">for</span> x <span class="py-keyword">in</span> a] +<span class="py-output">[4, 5, 6]</span></pre> +</div> <dl class="fields"> </dl> </td></tr></table> @@ -242,7 +242,7 @@ examples in doctest format </tr></table> <p>Do nothing.</p> - <p>I never saw a purple cow.</p> +<p>I never saw a purple cow.</p> <dl class="fields"> </dl> </td></tr></table> @@ -262,7 +262,7 @@ examples in doctest format </tr></table> <p>Do nothing.</p> - <p>I never hope to see one.</p> +<p>I never hope to see one.</p> <dl class="fields"> </dl> </td></tr></table> @@ -294,7 +294,7 @@ examples in doctest format <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> - Generated by Epydoc 3.0beta1 on Fri Dec 28 00:50:17 2007 + Generated by Epydoc 3.0beta1 on Tue Jan 22 00:26:36 2008 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" |