[SciPy-dev] Question about editing docs
Wed May 13 01:45:44 CDT 2009
Tue, 12 May 2009 15:57:22 -0500, Bruce Southey kirjoitti:
> My understanding is that virtually none of the stats functions have been
> edited as part of the SciPy documentation marathon. This means that
> nobody has edited the original docstring. Any effort to make the
> docstrings conform to the standards is welcome.
I don't think there has been an "official" push for a Scipy documentation
marathon. The doc editor is there, but nobody has checked eg. for
- Which docstrings are automatically generated.
For example, it may well be that scipy.stats.mstats copies its
docstrings from scipy.stats. There's no reliable way to determine this
automatically. So, I suggest checking this from the scipy.stats.mstats
source code, before editing the docstring of each function.
At least the functions gmean, hmean, and mode, do copy their docstrings.
- Which docstrings are not worth much concern.
More information about the Scipy-dev