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 LineFromDocstringField

Module model

Classes

Attribute
CanContainImportsDocumentable
Class
DocLocation
Documentable
DocumentableKind
Function
FunctionOverload
Inheritable
ISystemBuilder
LineFromAst
LineFromDocstringField
Module
Package
PrivacyClass
ProcessingState
System
SystemBuilder
SystemBuildingError

Functions

compute_mro
defaultPostProcess
get_docstring
import_mod_from_file_location
is_exception
prepend_package
_find_dunder_constructor
_inherits_instance_variable_kind

Variables

T
func_types
_STD_LIB_EXCEPTIONS
_default_extensions
_string_lineno_is_end

`pydoctor.model.LineFromDocstringField`

class documentation

class LineFromDocstringField(int): (source)

View In Hierarchy

Simple int wrapper for linenumbers coming from docstrings.

API Documentation for pydoctor, generated by pydoctor 23.9.0.dev0 at 2024-04-22 13:33:07.