[SciPy-Dev] Documenting distributions, advice?

Ralf Gommers ralf.gommers@googlemail....
Thu Jul 8 06:09:45 CDT 2010


On Wed, Jul 7, 2010 at 4:21 AM, <josef.pktd@gmail.com> wrote:

>
> Note I'm usually just using
> >>> np.source(stats.distributions.gamma_gen)
> >>> print stats.gamma.extradoc
>
> The rest is just repetition that I never read. "print
> stats.gamma.__doc__" is too much noise.
>
> Well, if the SNR improves you may change that habit:) If things are
unclear, like in the case of gamma that this thread started with, the
docstring is the only obvious place to clarify them. Users are just not
going to guess that the html/pdf docs contain a tutorial with essential info
missing from the docstring itself.


> Feel free to add any information that makes it more easily accessible,
> especially if Ralf thinks that the template system works without too
> much problem.
>

I haven't seen problems yet. If there are any they'll be ironed out quickly
enough once the system is exercised a bit more.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100708/7a9b9d5c/attachment-0001.html 


More information about the SciPy-Dev mailing list