pg.DocStr¶

Accessible via pg.DocStr, pg.utils.DocStr.

class DocStr(style, short_description, long_description, examples, args, returns, raises, blank_after_short_description=True)[source]¶

Bases: object

Docstring.

Attributes:

description

Returns short_description + long_description.

Methods:

`parameter`(param)	Returns doc str for an inspected parameter.
`parse`(text[, style])	Parses a docstring.

property description: str | None[source]¶: Returns short_description + long_description.

parameter(param)[source]¶

Returns doc str for an inspected parameter.

Return type:: Optional[pg.utils.DocStrArgument]

classmethod parse(text, style=None)[source]¶

Parses a docstring.

Return type:: pg.DocStr