[SciPy-Dev] import scipy convention in docstring Examples

David Goldsmith d.l.goldsmith@gmail....
Sun Jun 13 14:43:31 CDT 2010


On Sun, Jun 13, 2010 at 12:41 PM, Warren Weckesser <
warren.weckesser@enthought.com> wrote:

> David Goldsmith wrote:
> > Hi!  For the Examples in the numpy docstrings, we have the convention
> > that we do not need to include "import numpy" (because that is done by
> > our automated example tester) but when we're using a numpy namespace
> > object, we need to prefix it with "np." (because that's how our
> > automated tester is importing it).  Is there a similar convention for
> > docstring Examples in scipy?
> >
>
>
> According to http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines,
> "The examples may assume that import numpy as np is executed before the
> example code in numpy, and import scipy as sp in scipy. "  But sp does
> not appear to be widely used; I can only find it used in
> ndimage.geometric_transform and ndimage.map_coordinates.
>

Thanks, Warren, I d

>
> Warren
>
>
> > DG
> > ------------------------------------------------------------------------
> >
> > _______________________________________________
> > SciPy-Dev mailing list
> > SciPy-Dev@scipy.org
> > http://mail.scipy.org/mailman/listinfo/scipy-dev
> >
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>



-- 
Mathematician: noun, someone who disavows certainty when their uncertainty
set is non-empty, even if that set has measure zero.

Hope: noun, that delusive spirit which escaped Pandora's jar and, with her
lies, prevents mankind from committing a general suicide.  (As interpreted
by Robert Graves)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100613/2f5a6820/attachment-0001.html 


More information about the SciPy-Dev mailing list