pydoctor.epydoc.markup.ParseError

exception documentation

class ParseError(Exception): (source)

The base class for errors generated while parsing docstrings.

Method	`__init__`	No summary
Method	`__repr__`	Return the formal representation of this `ParseError`. `ParseError`s have formal representations of the form:
Method	`__str__`	Return a string representation of this `ParseError`. This multi-line string contains a description of the error, and specifies where it occured.
Method	`descr`	No summary
Method	`is_fatal`	No summary
Method	`linenum`	No summary
Instance Variable	`_descr`	Undocumented
Instance Variable	`_fatal`	Undocumented
Instance Variable	`_linenum`	Undocumented

def __init__(self, descr: str, linenum: int | None = None, is_fatal: bool = True): (source) ¶

overridden in pydoctor.epydoc.markup.epytext.ColorizingError

Parameters
descr:`str`	A description of the error.
linenum:`int \| None`	The line on which the error occured within the docstring. The linenum of the first line is 0.
is_fatal:`bool`	True if this is a fatal error.

def __repr__(self) -> str: (source) ¶

Return the formal representation of this ParseError. ParseErrors have formal representations of the form:

   <ParseError on line 12>

Returns
`str`	the formal representation of this `ParseError`.

Return a string representation of this ParseError. This multi-line string contains a description of the error, and specifies where it occured.

Returns
`str`	the informal representation of this `ParseError`.

overridden in pydoctor.epydoc.markup.epytext.ColorizingError

Returns
`str`	A description of the error.

def is_fatal(self) -> bool: (source) ¶

Returns
`bool`	true if this is a fatal error. If an error is fatal, then epydoc should ignore the output of the parser, and parse the docstring as plaintext.

def linenum(self) -> int | None: (source) ¶

Returns
`int \| None`	The line number on which the error occured (including any offset). If the line number is unknown, then return `None`.

Undocumented

Undocumented

Undocumented