module documentation
Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.
Class |
|
Undocumented |
Function | get |
Just return the parse_docstring function. |
Function | parse |
Parse the given docstring, which is formatted as plain text; and return a ParsedDocstring representation of its contents. |
Just return the parse_docstring
function.
Parameters | |
obj:Optional[ | Undocumented |
Returns | |
Callable[ | Undocumented |
Parse the given docstring, which is formatted as plain text; and return a ParsedDocstring
representation of its contents.
Parameters | |
docstring:str | The docstring to parse |
errors:List[ | A list where any errors generated during parsing will be stored. |
processtypes:bool | Undocumented |
Returns | |
ParsedDocstring | Undocumented |