scikit-image

1
import sys
2

3
from .._vendored.numpy_lookfor import lookfor as _lookfor
4

5

6
def lookfor(what):
7
    """Do a keyword search on scikit-image docstrings and print results.
8

9
    .. warning::
10

11
        This function may also print results that are not part of
12
        scikit-image's public API.
13

14
    Parameters
15
    ----------
16
    what : str
17
        Words to look for.
18

19
    Examples
20
    --------
21
    >>> import skimage as ski
22
    >>> ski.util.lookfor('regular_grid')
23
    Search results for 'regular_grid'
24
    ---------------------------------
25
    skimage.util.regular_grid
26
        Find `n_points` regularly spaced along `ar_shape`.
27
    skimage.util.lookfor
28
        Do a keyword search on scikit-image docstrings and print results.
29
    """
30
    return _lookfor(what, sys.modules[__name__.split('.')[0]])
31