Home > pylint-2.17.0

pylint 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 file_state

Variables

MessageStateDict

Package utils

Modules

ast_walker
docs
file_state
linterstats
pragma_parser
utils

Classes

ASTWalker
FileState
IsortDriver
LinterStats
ModuleStats

Functions

decoding_stream
diff_string
format_section
get_global_option
get_module_and_frameid
get_rst_section
get_rst_title
merge_stats
normalize_text
print_full_documentation
register_plugins
tokenize_module
_check_csv
_format_option_value
_splitstrip
_unquote

Variables

HAS_ISORT_5

`pylint.utils.file_state`

module documentation

(source)

Undocumented

Type Alias MessageStateDict Undocumented

MessageStateDict = (source) ¶

Undocumented

Value

Dict[str, Dict[int, bool]]

API Documentation for pylint, generated by pydoctor 22.9.1.dev0 at 2023-03-09 01:04:58.