Go to the latest version of this document.
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

# ``twisted`.`logger`.`_util``

module documentation
(source)

Logging utilities.

Function | `formatTrace` | Format a trace (that is, the contents of the `log_trace` key of a log event) as a visual indication of the message's propagation through various observers.

def formatTrace(trace): (source)

Format a trace (that is, the contents of the `log_trace` key of a log event) as a visual indication of the message's propagation through various observers.

Parameters
trace:`LogTrace` | the contents of the `log_trace` key from an event.
Returns
`str` | A multi-line string with indentation and arrows indicating the flow of the message through various observers.