docstring_parser.DocstringMeta

class documentation

class DocstringMeta: (source)

Known subclasses: docstring_parser.common.DocstringExample, docstring_parser.DocstringDeprecated, docstring_parser.DocstringParam, docstring_parser.DocstringRaises, docstring_parser.DocstringReturns

Constructor: DocstringMeta(args, description)

View In Hierarchy

Docstring meta information.

Symbolizes lines in form of

Parameters
argdescription
Raises
ValueErrorif something happens
Method __init__ Initialize self.
Instance Variable args Undocumented
Instance Variable description Undocumented
def __init__(self, args: list[str], description: str | None): (source)
overridden in docstring_parser.common.DocstringExample, docstring_parser.DocstringDeprecated, docstring_parser.DocstringParam, docstring_parser.DocstringRaises, docstring_parser.DocstringReturns

Initialize self.

Parameters
args:list[str]list of arguments. The exact content of this variable is dependent on the kind of docstring; it's used to distinguish between custom docstring meta information items.
description:str | Noneassociated docstring description.
args = (source)

Undocumented

description = (source)
overridden in docstring_parser.common.DocstringExample, docstring_parser.DocstringDeprecated, docstring_parser.DocstringRaises

Undocumented