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`.`python`.`usage`.`CoerceParameter``

class documentation

`class CoerceParameter: (source)`

Constructor: `CoerceParameter(options, coerce)`

View In Hierarchy

Utility class that can corce a parameter before storing it.

Method | `__init__` | No summary
Method | `dispatch` | When called in dispatch, do the coerce for `value` and save the returned value.
Instance Variable | `coerce` | Undocumented
Instance Variable | `doc` | Undocumented
Instance Variable | `options` | Undocumented

def __init__(self, options, coerce): (source)

Parameters
options | parent Options object
coerce | callable used to coerce the value.

def dispatch(self, parameterName, value): (source)

When called in dispatch, do the coerce for `value` and save the returned value.

coerce = (source)

Undocumented

doc = (source)

Undocumented

options = (source)

Undocumented