docstring_parser.DocstringReturns

class documentation

class DocstringReturns(DocstringMeta): (source)

Constructor: DocstringReturns(args, description, type_name, is_generator, ...)

View In Hierarchy

DocstringMeta symbolizing :returns or :yields metadata.

Method __init__ Initialize self.
Instance Variable is_generator Undocumented
Instance Variable return_name Undocumented
Instance Variable type_name Undocumented

Inherited from DocstringMeta:

Instance Variable args Undocumented
Instance Variable description Undocumented
def __init__(self, args: list[str], description: str | None, type_name: str | None, is_generator: bool, return_name: str | None = None): (source)
overrides docstring_parser.DocstringMeta.__init__

Initialize self.

is_generator = (source)

Undocumented

return_name = (source)

Undocumented

type_name = (source)

Undocumented