pg.DocStr¶

Accessible via pg.DocStr, pg.object_utils.DocStr.

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

Bases: object

Docstring.

Methods:

parse(text[, style])

Parses a docstring.

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

Parses a docstring.

Return type:: pg.DocStr