John Snow <js...@redhat.com> writes:

> Add the .. qapi:alternate:: directive, object, and qapi:alt:`name`
> cross-reference role.
>
> Add the "Choices:" field list for describing alternate choices. Like
> other field lists that reference QAPI types, a forthcoming commit will
> add cross-referencing support to this field.

Nothing wrong with the term "choices" per se, but
docs/devel/qapi-code-gen.rst and the Python code call these things
"alternatives".  I'd prefer consistency.  Could be done as a follow-up
if that's more convenient for you.

> RFC: In the future, it would be nice to directly inline Alternates as
> part of the type information in the containing object (i.e. directly in
> arguments/members) - but that's a task for another series.

Does it make sense to talk about future inlining projects when we
haven't even gotten to the present one, yet?

>                                                            For now, the
> branch "names" are documented just like qapidoc.py does, even though
> this information is superfluous for user documentation. Room for future
> improvement, but not now.

Same as before.  Good enough!

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


Reply via email to