Just looking at Robert Kern's checklist from a user's p.o.v., it would be nice to add some simple (one-liner) function call examples to each docstring. This is something I think is lacking from most functions in scipy. Gary R. Robert Kern wrote:
In the interest of improving the quality of the scipy.stats package, I hereby declare April and May of 2006 to be Statistics Review Months. I propose that we set ourselves a goal to review each function in stats.py and morestats.py (and a few others) for correctness and completeness of implementation by the end of May. By my count, that's about 2.5 functions every day. Surely this is a reasonable amount of effort for a rather large payoff: a robust, well-tested and thorough statistics library.
I have added a Wiki page describing the details: http://projects.scipy.org/scipy/scipy/wiki/StatisticsReview
Robert, Thanks for taking this suggestion on and adding it to the checklist. I agree with the importance of keeping any examples short. Gary Gary Ruben wrote:
Just looking at Robert Kern's checklist from a user's p.o.v., it would be nice to add some simple (one-liner) function call examples to each docstring. This is something I think is lacking from most functions in scipy.
Gary R.
participants (1)
-
Gary Ruben