finesse.script.adapter.NumpyStyleDocstringGetterMixin

Overview

class finesse.script.adapter.NumpyStyleDocstringGetterMixin(*, doc_type=None, **kwargs)

Bases: object

Properties

NumpyStyleDocstringGetterMixin.doc_type
NumpyStyleDocstringGetterMixin.docstring	The Python API item's docstring.

Methods

NumpyStyleDocstringGetterMixin.__init__(*[, ...])
NumpyStyleDocstringGetterMixin.argument_descriptions()	The types and descriptions for each argument as parsed from the docstring.
NumpyStyleDocstringGetterMixin.extended_summary()	The item's extended summary, parsed from the docstring.
NumpyStyleDocstringGetterMixin.summary()	The item's summary, parsed from the docstring.