Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.67 KB

README.md

File metadata and controls

26 lines (20 loc) · 1.67 KB
Raw

DocSeeker

Build Status

DocSeeker.jl provides utilities for handling documentation in local (so far) packages.

Usage

The main entry point is searchdocs(needle::AbstractString):

searchdocs("sin")

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 DocObj, which accumulate lots of metadata about a binding (e.g. name, type, location etc.).

searchdocs takes three keyword arguments:

  • loaded::Bool = true will search only packages in the current session, while loaded = false will search in all locally installed packages (actually only those in Pkg.installed()). Requires a call to DocSeeker.createdocsdb() beforehand.
  • mod::Module = Main will 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 = 20 will specify the maximum number of the results
  • exportedonly::Bool = false will search all names a module has, while exportedonly = true only takes exported names into consideration.
  • name_only::Bool = false will respect equalities between needle and both a binding's name and its doc text, while name_only = true only respects a equality to a binding's name.

Re-generation of the cache that powers the search in all installed packages can be triggered via 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.