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`.`_shellcomp`.`ZshSubcommandBuilder``

class documentation

`class ZshSubcommandBuilder(ZshBuilder): (source)`

Constructor: `ZshSubcommandBuilder(subOptions, *args)`

View In Hierarchy

Constructs zsh code that will complete options for a given usage.Options instance, and also for a single sub-command. This will only be used in the case where the user is completing options for a specific subcommand.

Method | `__init__` | Undocumented
Method | `write` | Generate the completion function and write it to the output file
Instance Variable | `subOptions` | The `twisted.python.usage.Options` instance defined for the sub command.

Inherited from `ZshBuilder`:

Instance Variable | `cmdName` | The name of the command we're generating completions for.
Instance Variable | `file` | The `file` to write the completion function to. The `file` must have `bytes` I/O semantics.
Instance Variable | `options` | The `twisted.python.usage.Options` instance defined for this command.

def __init__(self, subOptions, *args): (source)
overrides `twisted.python._shellcomp.ZshBuilder.__init__`

Undocumented

def write(self): (source)
overrides `twisted.python._shellcomp.ZshBuilder.write`

Generate the completion function and write it to the output file

Returns
`None`

subOptions: `twisted.python.usage.Options` = (source)

The `twisted.python.usage.Options` instance defined for the sub command.