John Snow <js...@redhat.com> writes: > This adds special rendering for Sphinx's typed field lists. > > This patch does not add any QAPI-aware markup, rendering, or > cross-referencing for the type names, yet. That feature requires a > subclass to TypedField which will happen in its own commit quite a bit > later in this series; after all the basic fields and objects have been > established first. > > The syntax for this field is: > > :arg type name: description > description cont'd > > You can omit the type or the description, but you cannot omit the name > -- if you do so, it degenerates into a "normal field list" entry, and > probably isn't what you want.
Exuse my nitpicking... "cannot omit" suggests omission is a hard error. The text after "--" suggests it isn't, it gives you something that "probably isn't what you want". Which way does it actually behave? > > Signed-off-by: John Snow <js...@redhat.com>
