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`.`web`.`microdom`.`Comment``

class documentation

`class Comment(CharacterData): (source)`

Constructor: `Comment(data, parentNode)`

View In Hierarchy

A comment node.

Method | `cloneNode` | Undocumented
Method | `writexml` | Undocumented

Inherited from `CharacterData`:

Method | `__init__` | Undocumented
Method | `isEqualToCharacterData` | Undocumented
Instance Variable | `data` | Undocumented
Instance Variable | `nodeValue` | Undocumented
Instance Variable | `value` | Undocumented

Inherited from `Node` (via `CharacterData`):

Method | `appendChild` | Make the given `Node` the last child of this node.
Method | `firstChild` | Undocumented
Method | `hasChildNodes` | Undocumented
Method | `insertBefore` | Make the given `Node` `new` a child of this node which comes before the `Node` `ref`.
Method | `isEqualToNode` | Compare this node to `other`. If the nodes have the same number of children and corresponding children are equal to each other, return `True`, otherwise return `False`.
Method | `lastChild` | Undocumented
Method | `removeChild` | Remove the given `Node` from this node's children.
Method | `replaceChild` | Replace a `Node` which is already a child of this node with a different node.
Method | `toprettyxml` | Undocumented
Method | `toxml` | Undocumented
Method | `writeprettyxml` | Undocumented
Class Variable | `nodeName` | Undocumented
Instance Variable | `childNodes` | Undocumented
Instance Variable | `parentNode` | Undocumented

def cloneNode(self, deep=0, parent=None): (source)
overrides `twisted.web.microdom.Node.cloneNode`

Undocumented

def writexml(self, stream, indent='', addindent='', newl='', strip=0, nsprefixes={}, namespace=''): (source)
overrides `twisted.web.microdom.Node.writexml`

Undocumented