Home > hityper-1.0.2

hityper 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 config

Variables

config

Package hityper

Modules

config
rej_typerule
stdtypes
tdg
tdg_generator
typeobject
typerule
usertype_finder
utils
__main__

Variables

__version__
ch
formatter
logger

`hityper.config`

module documentation

(source)

Undocumented

Variable config Undocumented

config: dict = (source) ¶

Undocumented

API Documentation for hityper, generated by pydoctor 22.9.1 at 2022-11-11 17:21:34.