[SciPy-Dev] import scipy convention in docstring Examples

Robert Kern robert.kern@gmail....
Sun Jun 13 15:15:27 CDT 2010


On Sun, Jun 13, 2010 at 15:03,  <josef.pktd@gmail.com> wrote:
> On Sun, Jun 13, 2010 at 3:43 PM, David Goldsmith
> <d.l.goldsmith@gmail.com> wrote:
>> 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
>
> import scipy is not very useful, since it doesn't import the sub-packages

Correct, and doing so should not be encouraged by the examples.

> I think the most common use is
> from scipy import signal, optimize, stats
>
> or maybe
> import scipy.ndimage as ndi
>
> but I don't know whether there are recommendations for the convention or rules

I recommend against abbreviating the subpackage names.

-- 
Robert Kern

"I have come to believe that the whole world is an enigma, a harmless
enigma that is made terrible by our own mad attempt to interpret it as
though it had an underlying truth."
  -- Umberto Eco


More information about the SciPy-Dev mailing list