pydocstring.formatters.reST¶

reST Docstring Formatter

pydocstring.formatters.reST.class_docstring(parso_class)¶

Format a reST docstring for a class

Only documents attributes, __init__ method args can be documented on the __init__ method

Parameters:	parso_class (Class) – The class tree node
Returns:	The formatted docstring
Return type:	str

pydocstring.formatters.reST.function_docstring(parso_function)¶

Format a reST docstring for a function

Parameters:	parso_function (Function) – The function tree node
Returns:	The formatted docstring
Return type:	str

pydocstring.formatters.reST.module_docstring(parso_module)¶

Format a reST docstring for a module

Only documents attributes, __init__ method args can be documented on the __init__ method

Parameters:	parso_module (Module) – The module tree node
Returns:	The formatted docstring
Return type:	str