Home > lunr-0.6.2

lunr API Documentation Modules Classes Names

search in docstrings

Search bar offers the following options:

Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”: foo*
Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module exceptions

Classes

BaseLunrException
QueryParseError

Package lunr

Modules

languages
builder
exceptions
field_ref
idf
index
match_data
pipeline
query
query_lexer
query_parser
stemmer
stop_word_filter
token
token_set
token_set_builder
tokenizer
trimmer
utils
vector
__main__

Functions

get_default_builder
lunr

Variables

__TARGET_JS_VERSION__
__VERSION__

`lunr.exceptions`

module documentation

(source)

Undocumented

Class	`BaseLunrException`	Undocumented
Class	`QueryParseError`	Undocumented

API Documentation for lunr, generated by pydoctor 22.5.1 at 2022-07-13 20:29:32.