<br><br><div class="gmail_quote">On Jan 21, 2008 6:09 PM, Jarrod Millman &lt;<a href="mailto:millman@berkeley.edu">millman@berkeley.edu</a>&gt; wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<div class="Ih2E3d">On Jan 21, 2008 2:03 PM, Matthew Brett &lt;<a href="mailto:matthew.brett@gmail.com">matthew.brett@gmail.com</a>&gt; wrote:<br>&gt; Search for the docstring standard, I hit this:<br>&gt;<br>&gt; <a href="http://www.scipy.org/DocstringStandard" target="_blank">
http://www.scipy.org/DocstringStandard</a><br><br></div>Good catch, I didn&#39;t know this page existed. &nbsp;If I recall correctly,<br>Keir Mierle showed up on the mailing list around the time we were<br>discussing the docstring standard. &nbsp;He proposed to do some work, but
<br>then must have gotten busy with something else. &nbsp;In particular, I<br>believe he was interested in seeing a unified docstring standard for<br>numpy, scipy, and matplotlib. &nbsp;I guess he put this page up during that<br>period. &nbsp;I went ahead and deleted it, since it conflicts with the
<br>official docstring standard.<br><div class="Ih2E3d"><br>&gt; but I think the current thinking is this:<br>&gt;<br>&gt; <a href="http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines" target="_blank">http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines
</a><br>&gt;<br>&gt; Is that correct? Does the first page apply to matplotlib in some way?<br>&gt; Should we change the first page to match the second now?<br><br></div>Yes. &nbsp;That page is autogenerated from the official coding standard
<br>that is in the numpy trunk. &nbsp;One of the nice features of trac is that<br>it can render restructured text from the svn repository. &nbsp;This helps<br>us keep from having duplicate information that needs to be kept in<br>sync by hand.
<br></blockquote><div><br>If I hit the source code link in the generated&nbsp; html, it looks like that page was generated from the old document format. The new document format doesn&#39;t produce output that looks anything like that and epydoc generates a couple of warnings:
<br><br><span style="font-family: courier new,monospace;">| File /home/charris/workspace/numpy/numpy/doc/example.py, line 19, in </span><br style="font-family: courier new,monospace;"><span style="font-family: courier new,monospace;">
| example.foo</span><br style="font-family: courier new,monospace;"><span style="font-family: courier new,monospace;">|&nbsp;&nbsp; Warning: Line 24: Wrong underline character for heading.</span><br style="font-family: courier new,monospace;">
<span style="font-family: courier new,monospace;">|&nbsp;&nbsp; Warning: Lines 27, 30, 32, 37, 39, 41, 43, 48, 50: Improper paragraph </span><br style="font-family: courier new,monospace;"><span style="font-family: courier new,monospace;">
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; indentation.</span><br><br></div><div>The new document format requires a preprocessor that has yet to be written.<br><br>Chuck <br></div><br></div><br>