[Numpy-discussion] ANN: NumPy/SciPy Documentation Marathon 2008
Rob Hetland
hetland at tamu.edu
Wed May 21 03:27:10 EDT 2008
Should we add a general discussion section to the Wiki? I would just
do this, but it seems like a fundamental enough addition that I though
I would suggest it first. The rational is that there are some
stylistic questions that are not covered in the example. For
instance, I think that the See Also section should have a format like
this:
See Also
--------
function : One line description from function's docstring
Longer description here over potentially many lines. Lorem ipsum
dolor sit amet,
consectetur adipisicing elit, sed do eiusmod tempor incididunt ut
labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation
ullamco laboris nisi
ut aliquip ex ea commodo consequat.
next_function : One line description from next_function's docstring
Longer description here over potentially many lines. Lorem ipsum
dolor sit amet,
consectetur adipisicing elit, sed do eiusmod tempor incididunt ut
labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation
ullamco laboris nisi
ut aliquip ex ea commodo consequat.
This will parse better (as the line with the semicolon is bold, the
next lines are not). Also, would it be possible to put function and
next_function in double back-ticks, so that they are referenced, like
modules? That way they will might be clickable in a html version of
the documentation.
-Rob
More information about the NumPy-Discussion
mailing list