Improve the documentation style for human-readability in plain-text

1 files changed, 70 insertions, 70 deletions

diff --git a/numpy/doc/html/example-module.html b/numpy/doc/html/example-module.html
index 847ae8f1d..7a9fdfd5a 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&nbsp;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>
@@ -166,63 +166,63 @@ a line by itself, preferably preceeded by a blank line.</p>
   </td><td align="right" valign="top"
     ><span class="codelink"><a href="example-pysrc.html#foo">source&nbsp;code</a></span>&nbsp;
     </td>
-  </table>
+  </tr></table>
   
-  <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>
-<p><em>Parameters</em>:</p>
-<blockquote>
-<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>
-</blockquote>
-<p><em>Returns</em>:</p>
-<blockquote>
-<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>
-</blockquote>
-<p><em>Other Parameters</em>:</p>
-<blockquote>
-<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>
-</blockquote>
-<p><em>See Also</em>:</p>
-<blockquote>
-<p><a href="example-module.html#otherfunc" class="link">otherfunc</a> : relationship (optional)</p>
-<p><a href="example-module.html#newfunc" class="link">newfunc</a> : relationship (optional)</p>
-</blockquote>
-<p><em>Notes</em></p>
-<blockquote>
-<p>Notes about the implementation algorithm (if needed).</p>
-<p>This can have multiple paragraphs as can all sections.</p>
-</blockquote>
-<p><em>Examples</em></p>
-<blockquote>
-<p>examples in doctest format</p>
-<pre class="py-doctest">
-<span class="py-prompt">&gt;&gt;&gt; </span>a=[1,2,3]
-<span class="py-prompt">&gt;&gt;&gt; </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>
-</blockquote>
+  <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
+
+&gt;&gt;&gt; a=[1,2,3]
+&gt;&gt;&gt; [x + 3 for x in a]
+[4, 5, 6]
+
+</pre>
   <dl class="fields">
   </dl>
 </td></tr></table>
@@ -239,10 +239,10 @@ that can be converted to an array.</dd>
   </td><td align="right" valign="top"
     ><span class="codelink"><a href="example-pysrc.html#newfunc">source&nbsp;code</a></span>&nbsp;
     </td>
-  </table>
+  </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>
@@ -259,10 +259,10 @@ that can be converted to an array.</dd>
   </td><td align="right" valign="top"
     ><span class="codelink"><a href="example-pysrc.html#otherfunc">source&nbsp;code</a></span>&nbsp;
     </td>
-  </table>
+  </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,10 +294,11 @@ that can be converted to an array.</dd>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0beta1 on Sun Sep 23 13:30:28 2007
+    Generated by Epydoc 3.0beta1 on Fri Dec 28 00:50:17 2007
     </td>
     <td align="right" class="footer">
-      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
+      <a target="mainFrame" href="http://epydoc.sourceforge.net"
+        >http://epydoc.sourceforge.net</a>
     </td>
   </tr>
 </table>
@@ -308,9 +309,8 @@ that can be converted to an array.</dd>
   // javascript is turned off then we want them to be
   // visible); but by default, we want to hide them.  So hide
   // them unless we have a cookie that says to show them.
-  checkCookie()
+  checkCookie();
   // -->
 </script>
-  
 </body>
 </html>