Skip to content

types ¤

Classes:

Name Description
BaseDocStringParser

Base class for docstring parsers.

BaseDocStringParser ¤

Bases: ABC

Base class for docstring parsers.

Attributes:

Name Type Description
freeform DocstringFreeform

Return the freeform docstring

params DocstringParams

Return the params/arguments docstring

returns DocstringReturn

Return the return docstring

freeform property ¤

freeform: DocstringFreeform

Return the freeform docstring

params property ¤

params: DocstringParams

Return the params/arguments docstring

returns property ¤

returns: DocstringReturn

Return the return docstring