[Numpy-discussion] Doctest items

Alan McIntyre alan.mcintyre at gmail.com
Tue Jul 1 20:33:08 EDT 2008


On Tue, Jul 1, 2008 at 4:41 PM, Pauli Virtanen <pav at iki.fi> wrote:
> All in all, I'd estimate this to be ~100 lines, put in a suitable
> location.
>
> If possible, I'd like other possibilities be considered first before
> jumping this route. I think it would be nice to retain the ability to run
> also the matplotlib examples as (optional) doctests, to make sure also
> they execute correctly. Also, using two different markups in the
> documentation to work around a shortcoming of doctest is IMHO not very
> elegant.

Well, for the moment, it's 100 lines of new code that's needed in
order to *avoid* running 10 lines of doctest code in one function's
docstring.  Maybe down the road there will be more examples that need
a bulk "don't execute me" mechanism, and if we do I'll be glad to work
on it, but for right now I need to spend more time increasing
coverage.

I also agree with Ryan that matplotlib is where the tests for this
particular use case of the object returned by bartlett should be.  So
at the moment I'm inclined to just remove the ">>>" and come back to
it later.



More information about the NumPy-Discussion mailing list