[SciPy-dev] FFT docstrings (was: Scipy Tutorial (and updating it))

Alan Jackson alan@ajackson....
Sun Dec 14 18:28:11 CST 2008


On Sat, 13 Dec 2008 13:48:51 -0500
jh@physics.ucf.edu wrote:

> On Fri, Dec 12, 2008 at 03:19:05PM -0500, jh@physics.ucf.edu wrote:
> > Also, the current routine examples satisfy a mathematician but do not
> > give insight into what the FT actually *does*, i.e., extract the
> > periodic content of a signal.
> 
> Gael responded:
> > Yes, I was thinking similarly. This is exactly why I brought up the
> > question about plotting.
> 
> We avoid plots when possible, of course, but I think that if ever
> there were a case for a line plot in numpy, it would be fft.  The
> constraints are that we want a plot in the docs but can't have one in
> the most basic doc reader, help().  A compromise might be to put it in
> the package docstring and not the routine docstrings.  We might also
> include the full filename of the plot, so someone working in text
> could view the plot separately.
> 

For many of the fuctions I documented, I put code in the Example that would
produce a (hopefully) enlightening plot.


-- 
-----------------------------------------------------------------------
| Alan K. Jackson            | To see a World in a Grain of Sand      |
| alan@ajackson.org          | And a Heaven in a Wild Flower,         |
| www.ajackson.org           | Hold Infinity in the palm of your hand |
| Houston, Texas             | And Eternity in an hour. - Blake       |
-----------------------------------------------------------------------


More information about the Scipy-dev mailing list