Skip to main content

Module index

Module index 

Source
Expand description

Per-package index: entries plus their term frequencies, cached on disk by package, exact version and source location.

Structs§

PackageIndex

Constants§

FORMAT
Bump when extraction or the on-disk format changes.

Functions§

build
embed_text
What an entry means, for the embedding: its name and the start of its prose (code examples and long signatures dilute a mean-pooled vector).
entry_tf
Weighted terms: names and headings count most, doc prose next, code examples and signatures least (they repeat incidental identifiers).
head_tf
Heading (or name) and first sentence: what an entry says it is about.
load_or_build
Load from the disk cache, or build and store.
summary
The first sentence of a doc comment.