Re: [PATCH v3 1/5] docs/sphinx: adjust qapidoc to cope with same-line error sections

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> Signed-off-by: John Snow <jsnow@redhat.com>

Let's mention the reproducer: "# Errors: some" in doc-good.json with
:transmogrify:.

> ---
>  docs/sphinx/qapidoc.py | 12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
>
> diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
> index 8011ac9efaf..5374dee8fad 100644
> --- a/docs/sphinx/qapidoc.py
> +++ b/docs/sphinx/qapidoc.py
> @@ -267,10 +267,14 @@ def visit_returns(self, section: QAPIDoc.Section) -> None:
>          self.add_field("return", typ, section.text, section.info)
>  
>      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.
> -        self.add_lines(f":error:\n{section.text}", section.info)
> +        # If the section text does not start with a space, it means text
> +        # began on the same line as the "Error:" string and we should
> +        # not insert a newline in this case.
> +        if section.text[0].isspace():
> +            text = f":error:\n{section.text}"
> +        else:
> +            text = f":error: {section.text}"
> +        self.add_lines(text, section.info)
>  
>      def preamble(self, ent: QAPISchemaDefinition) -> None:
>          """