[SciPy-user] Docstring searching capability in scipy

Robert Kern rkern at ucsd.edu
Fri Oct 21 22:24:44 CDT 2005


Fernando Perez wrote:
> Travis Oliphant wrote:
> 
>>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.
> 
> In the spirit of scipy for numerics, matplotlib for plotting and ipython for 
> interactive work, perhaps we should copy this over to ipython.  Opinions?

Yes, please! Among other things, that would allow it to scan scipy and
other packages for docstrings and store the snippets of documentation
(doclets?) somewhere in ~/.ipython/ . Then we can search without
importing anything or scanning every time.

-- 
Robert Kern
rkern at ucsd.edu

"In the fields of hell where the grass grows high
 Are the graves of dreams allowed to die."
  -- Richard Harter



More information about the SciPy-user mailing list