parse_func_docs
FunctionSource
v_1: DocFunction = parse_func_docs(func: Any, base_cls: type[Any] | None = None)
Parse the docstring of a function.
Arguments
Requires
| Name | Type | Required | |
|---|---|---|---|
func | Any | A function object to be parsed. It can be a vanilla function or a method. | |
base_cls | type[Any] | None | An optional base class. If provided, will check whether func is a member and a method of the given base_cls. |
Returns
| Name | Type | |
|---|---|---|
v_1 | DocFunction | The parsed docstring of the function/method. |