[Numpy-discussion] #734: interactive docstring search (lookfor)

[Robert Kern]

On Thu, Apr 10, 2008 at 4:54 PM, Hoyt Koepke <hoytak@gmail.com> wrote:
> My personal 2 cents is that we should put it in the most easy-to-find
>  place.  I wish I had the propsed lookfor function at my fingertips
>  when I started to learn numpy/scipy a year ago, coming from matlab.
>  Like many others (I assume), I just jumped in and learned what numpy
>  could do by trial and error and I never noticed numpy.lib.utils.info.
>  Thus my personal vote (though I understand this may not be the best
>  and there are arguments against it) is to put a lookfor or info
>  function in the top level namespace, with an obvious name, so newbies
>  could easily run across it and have a more enjoyable numpy learning
>  experience.


In [1]: import numpy

In [2]: numpy.info('eigvals')
     *** Found in numpy.linalg ***
 eigvals(a)
...

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