[SciPy-user] docstring cross-references [PATCH]

Robert Kern robert.kern at gmail.com
Sat Sep 23 16:54:31 CDT 2006


A. M. Archibald wrote:
> Hi,
> 
> I've quickly gone through and done some cross-referencing of
> docstrings in scipy. Only the modules interpolate, integrate, and
> optimize have cross-references so far. I looked at special, but there
> are so many special functions I'm not sure what to do (for example,
> should the docstring on Bessel functions list modified Bessel
> functions? spherical Bessel functions?).

I'd suggest just leaving most of it alone. The categorized info.py is probably 
more useful.

> That's all the packages I've
> had occasion to use, so the others would take longer.

I've checked in most of your patch. I have local modifications to interpolate.py 
that I will check in later today with your cross-reference information.

> I'm afraid the cross-referencing is not neccessarily very consistent
> in formatting, but then neither are the docstrings themselves.

Heh. You ain't kidding.

-- 
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