John Snow <[email protected]> writes:
> Notably, this method does not currently address the formatting issues
> present with the "errors" section in QAPIDoc and just vomits the text
> verbatim into the rST doc, with somewhat inconsistent results.
>
> To be addressed in a future revision.
>
> Signed-off-by: John Snow <[email protected]>
> ---
> docs/sphinx/qapidoc.py | 6 ++++++
> 1 file changed, 6 insertions(+)
>
> diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
> index b96445f0802..14feafe866e 100644
> --- a/docs/sphinx/qapidoc.py
> +++ b/docs/sphinx/qapidoc.py
> @@ -139,6 +139,12 @@ def visit_paragraph(self, section: QAPIDoc.Section) ->
> None:
> self.add_lines(section.text, section.info)
> self.ensure_blank_line()
>
> + def visit_errors(self, section: QAPIDoc.Section) -> None:
> + # FIXME: the formatting for errors may be inconsistent and may
> + # or may not require different newline placement to ensure
> + # proper rendering as a nested list.
Is the FIXME worth mentioning in the commit message?
> + self.add_lines(f":error:\n{section.text}", section.info)
> +
> def preamble(self, ent: QAPISchemaDefinition) -> None:
> """
> Generate option lines for qapi entity directives.
