[SciPy-user] Documentation

Robert Kern robert.kern@gmail....
Thu Sep 25 17:57:34 CDT 2008


On Thu, Sep 25, 2008 at 17:30, Anne Archibald <peridot.faceted@gmail.com> wrote:
> Hi,
>
> I've just written a description of how scipy's smoothing splines work
> (because a friend is publishing a paper that used them). I had to go
> look up the original research papers, because there isn't really a
> good description in the python documentation, or even in the FITPACK
> source. It seems like it would be valuable to have such a description,
> but I'm not sure where it should go: duplicated in every one of
> scipy's spline-fitting functions? at the module level? in some
> automatic docstring transmogrifier that puts it in all relevant
> docstrings without requiring source code duplication?

We could probably put it in the module docstring and then say "See the
docstring for scipy.interpolate.fitpack2 for details about the
algorithm." in the individual functions.

-- 
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-user mailing list