[SciPy-user] Docstring standards for NumPy and SciPy

Gael Varoquaux gael.varoquaux at normalesup.org
Thu Jan 11 05:31:18 CST 2007


On Thu, Jan 11, 2007 at 10:27:46PM +1100, Gary Ruben wrote:
> I'm not sure I can add much to this discussion, except that currently no 
> tools seem to do exactly what I think we want with ReST anyway, so if 
> we're going to rely on existing tools, ReST may not be all that useful. 


Well it is very easy to build tools using the docutils. Once the
docstrings are extracted the layout becomes easy. Another reason to use
ReST is that is can also go on the wiki. One could imagine Wiki editing
of the docstrings. Yes I know, I am getting a bit carried away.

Gaël


More information about the SciPy-user mailing list