pydoctor.epydoc.markup.plaintext

module documentation
(source)

Parser for plaintext docstrings. Plaintext docstrings are rendered as verbatim output, preserving all whitespace.

Class ParsedPlaintextDocstring 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: Documentable | None) -> ParserFunction: (source)

Just return the parse_docstring function.

def parse_docstring(docstring: str, errors: list[ParseError]) -> ParsedDocstring: (source)

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.
Returns
ParsedDocstringUndocumented