DocSeeker.jl provides utilities for handling documentation in local (so far) packages.
The main entry point is
will return a vector of tuples of scores and their corresponding match. Scores are numbers
between 0 and 1, and represent the quality of a given match. Matches are
accumulate lots of metadata about a binding (e.g. name, type, location etc.).
searchdocs takes three keyword arguments:
loaded::Bool = truewill search only packages in the current session, while
loaded = falsewill search in all locally installed packages (actually only those in
Pkg.installed()). Requires a call to
mod::Module = Mainwill filter out bindings that can't be reached from the given module -- by default every loaded package will be searched.
maxreturns::Int = DocSeeker.MAX_RETURN_SIZE = 20will specify the maximum number of the results
exportedonly::Bool = falsewill search all names a module has, while
exportedonly = trueonly takes exported names into consideration.
name_only::Bool = falsewill respect equalities between
needleand both a binding's name and its doc text, while
name_only = trueonly respects a equality to a binding's name.
Re-generation of the cache that powers the search in all installed packages can be triggered
DocSeeker.createdocsdb() (async, so no worries about killing you julia session). For now,
there is no automatic re-generation, though that'll be implemented soon.