docstring_parser.common.DocstringExample

class documentation

class DocstringExample(DocstringMeta): (source)

Constructor: DocstringExample(args, snippet, description)

View In Hierarchy

DocstringMeta symbolizing example metadata.

Method __init__ Initialize self.
Instance Variable description Undocumented
Instance Variable snippet Undocumented

Inherited from DocstringMeta:

Instance Variable args Undocumented
def __init__(self, args: list[str], snippet: str | None, description: str | None): (source)
overrides docstring_parser.DocstringMeta.__init__

Initialize self.

description = (source)
overrides docstring_parser.DocstringMeta.description

Undocumented

snippet = (source)

Undocumented