qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v7 05/10] qapidoc: introduce QAPISchemaIfCond.docgen()


From: Marc-André Lureau
Subject: Re: [PATCH v7 05/10] qapidoc: introduce QAPISchemaIfCond.docgen()
Date: Thu, 5 Aug 2021 16:02:09 +0400

Hi

On Thu, Aug 5, 2021 at 3:55 PM Markus Armbruster <armbru@redhat.com> wrote:
marcandre.lureau@redhat.com writes:

> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> Instead of building the condition documentation from a list of string,
> use the result generated from QAPISchemaIfCond.docgen().
>
> This changes the generated documentation from:
> - COND1, COND2... (where COND1, COND2 are Literal nodes, and ',' is Text)
> to:
> - COND1 and COND2 (the whole string as a Literal node)
>
> This will allow us to generate more complex conditions in the following
> patches, such as "(COND1 and COND2) or COND3".
>
> Adding back the differentiated formatting is left to the wish list.

What about a TODO comment?   you suggest a suitable spot?

I don't think this matters much, it will never be a user-friendly text. But we can leave a comment in the docgen() function to say that the sphinx build could benefit from a formatted string.

 
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>




--
Marc-André Lureau

reply via email to

[Prev in Thread] Current Thread [Next in Thread]