docstring_parser.Docstring

class documentation

class Docstring: (source)

Constructor: Docstring(style)

View In Hierarchy

Docstring object representation.

Method __init__ Initialize self.
Instance Variable blank_after_long_description Undocumented
Instance Variable blank_after_short_description Undocumented
Instance Variable long_description Undocumented
Instance Variable meta Undocumented
Instance Variable short_description Undocumented
Instance Variable style Undocumented
Property deprecation Return a single information on function deprecation notes.
Property description Return the full description of the function
Property examples Return a list of information on function examples.
Property many_returns Return a list of information on function return.
Property params Return a list of information on function params.
Property raises Return a list of information on the exceptions that the function may raise.
Property returns Return a single information on function return.
def __init__(self, style=None): (source)

Initialize self.

blank_after_long_description: bool = (source)

Undocumented

blank_after_short_description: bool = (source)

Undocumented

long_description: str | None = (source)

Undocumented

meta: list[DocstringMeta] = (source)

Undocumented

short_description: str | None = (source)

Undocumented

style: DocstringStyle | None = (source)

Undocumented

deprecation: DocstringDeprecated | None = (source)

Return a single information on function deprecation notes.

description: str | None = (source)

Return the full description of the function

Returns None if the docstring did not include any description

examples: list[DocstringExample] = (source)

Return a list of information on function examples.

many_returns: list[DocstringReturns] = (source)

Return a list of information on function return.

params: list[DocstringParam] = (source)

Return a list of information on function params.

raises: list[DocstringRaises] = (source)

Return a list of information on the exceptions that the function may raise.

returns: DocstringReturns | None = (source)

Return a single information on function return.

Takes the first return information.