Documentation Suggestion

5 views

Skip to first unread message

Kyle Mandli

unread,

Dec 17, 2012, 10:35:05 AM12/17/12

to claw...@googlegroups.com

It just came to my attention that the NumPy/SciPy community has created a new documentation guide that addresses many questions we have had in the past about documentation, especially in docstrings.

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Also our documentation coverage and accuracy is somewhat uneven currently so if you add or change any code make sure to take a look at the local documentation and see if it is correct or could use some help.