Home > invoke-2.0.0

invoke 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 reader

Classes

Reader
ReaderError

Package yaml

Modules

composer
constructor
cyaml
dumper
emitter
error
events
loader
nodes
parser
reader
representer
resolver
scanner
serializer
tokens

Classes

YAMLObject
YAMLObjectMetaclass
YAMLLoadWarning

Functions

add_constructor
add_implicit_resolver
add_multi_constructor
add_multi_representer
add_path_resolver
add_representer
compose
compose_all
dump
dump_all
emit
full_load
full_load_all
load
load_all
load_warning
parse
safe_dump
safe_dump_all
safe_load
safe_load_all
scan
serialize
serialize_all
unsafe_load
unsafe_load_all
warnings

Variables

__version__
__with_libyaml__
_warnings_enabled

`invoke.vendor.yaml.reader`

module documentation

(source)

Undocumented

Class	`Reader`	Undocumented
Exception	`ReaderError`	Undocumented

API Documentation for invoke, generated by pydoctor 22.9.1 at 2023-01-17 00:58:33.