numpy.lookfor

numpy.lookfor(what, module=None, import_modules=True, regenerate=False)

Do a keyword search on docstrings.

A list of of objects that matched the search is displayed, sorted by relevance.

Parameters:

what : str

String containing words to look for.

module : str, module

Module whose docstrings to go through.

import_modules : bool

Whether to import sub-modules in packages. Will import only modules in __all__.

regenerate : bool

Whether to re-generate the docstring cache.

Examples

>>> np.lookfor('binary representation')
Search results for 'binary representation'
------------------------------------------
numpy.binary_repr
    Return the binary representation of the input number as a string.