motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-01 06:43:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/qapi-domain: add "Errors:" field lists

Browse source 
``:error: descr`` can now be used to document error conditions. The
format of the description is not defined here; so the ability to name
specific types is left to the document writer.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-18-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-03-10 23:42:15 -04:00 • committed by Markus Armbruster
parent 3d9a23f92f
commit 9605c20477
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/sphinx/qapi_domain.py
View file

@ -33,7 +33,7 @@ from sphinx.domains import (
from sphinx.locale import _, __ from sphinx.locale import _, __
from sphinx.roles import XRefRole from sphinx.roles import XRefRole
from sphinx.util import logging from sphinx.util import logging
from sphinx.util.docfields import GroupedField, TypedField from sphinx.util.docfields import Field, GroupedField, TypedField
from sphinx.util.nodes import make_id, make_refnode from sphinx.util.nodes import make_id, make_refnode
@ -294,6 +294,13 @@ class QAPICommand(QAPIObject):
names=("arg",), names=("arg",),
can_collapse=False, can_collapse=False,
), ),
# :error: descr
Field(
"error",
label=_("Errors"),
names=("error", "errors"),
has_arg=False,
),
] ]
) )