Home > pydoctor-22.9.1

pydoctor 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

Class KeywordArgument

Module epydoc2stan

Classes

Field
FieldDesc
FieldHandler
KeywordArgument
ParsedStanOnly
RaisesDesc
VariableArgument

Functions

colorized_pyval_fallback
ensure_parsed_docstring
extract_fields
format_constant_value
format_desc_list
format_docstring
format_docstring_fallback
format_field_list
format_kind
format_summary
format_summary_fallback
format_toc
format_undocumented
get_docstring
get_parsed_type
get_parser
get_to_stan_error
insert_break_points
parse_docstring
reportErrors
reportWarnings
safe_to_stan
type2stan
_format_constant_value
_get_parsed_summary
_is_none_literal
_split_indentifier_parts_on_case

Variables

BROKEN
field_name_to_kind

`pydoctor.epydoc2stan.KeywordArgument`

class documentation

class KeywordArgument(str): (source)

View In Hierarchy

Encapsulate the name of kwarg parameters.

API Documentation for pydoctor, generated by pydoctor 22.9.1 at 2022-09-19 01:21:19.