pydoctor.epydoc.markup.plaintext

module documentation

Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.
Class ​Parsed​Plaintext​Docstring Undocumented
Function get​_parser Just return the parse_docstring function.
Function parse​_docstring Parse the given docstring, which is formatted as plain text; and return a ParsedDocstring representation of its contents.
def get_parser(obj):
Just return the parse_docstring function.
Parameters
obj:Optional[Documentable]Undocumented
Returns
Callable[[str, List[ParseError], bool], ParsedDocstring]Undocumented
def parse_docstring(docstring, errors, processtypes=False):
Parse the given docstring, which is formatted as plain text; and return a ParsedDocstring representation of its contents.
Parameters
docstring:strThe docstring to parse
errors:List[ParseError]A list where any errors generated during parsing will be stored.
processtypes:boolUndocumented
Returns
ParsedDocstringUndocumented