[SciPy-user] Docstring searching capability in scipy

Travis Oliphant oliphant at ee.byu.edu
Fri Oct 21 18:18:23 CDT 2005


Robert Kern wrote:

>We have fairly good docstring coverage in scipy at least. We need to
>build some searching capability, though.
>  
>
There is a little bit of searching in  scipy's info

info('minimize') will look through the docstrings and report functions
containing that word.

In new scipy info is in  *scipy.utils.helpmod* until we figure out what 
to do with it.

If you are running new scipy
 >>> from scipy.utils.helpmod import info
or
 >>> from scipy import info

if you are running old scipy.

info was written just before help was available from Python,  but it still
returns more docstring information than help does.

compare

help(scipy.sin)

info(scipy.sin)

-Travis




More information about the SciPy-user mailing list