@@ -239,8 +239,8 @@ def _nodes_for_features(self, doc):
seen_item = False
dlnode = nodes.definition_list()
for section in doc.features.values():
- dlnode += self._make_dlitem([nodes.literal('', section.name)],
- section.text)
+ dlnode += self._make_dlitem(
+ [nodes.literal('', section.member.name)], section.text)
seen_item = True
if not seen_item:
@@ -476,9 +476,9 @@ def __init__(self, parser: QAPISchemaParser,
self.info = parser.info
# parser, for error messages about indentation
self._parser = parser
- # optional section name (argument/member or section name)
+ # section tag, if any ('Returns', '@name', ...)
self.name = name
- # section text without section name
+ # section text without tag
self.text = ''
# indentation to strip (None means indeterminate)
self._indent = None if self.name else 0
@@ -700,7 +700,7 @@ def _start_symbol_section(
raise QAPIParseError(self._parser,
"'%s' parameter name duplicated" % name)
assert not self.sections
- new_section = QAPIDoc.ArgSection(self._parser, name)
+ new_section = QAPIDoc.ArgSection(self._parser, '@' + name)
self._switch_section(new_section)
symbols_dict[name] = new_section
@@ -727,9 +727,9 @@ def _switch_section(self, new_section: 'QAPIDoc.Section') -> None:
# We do not create anonymous sections unless there is
# something to put in them; this is a parser bug.
assert self._section.name
- raise QAPIParseError(
- self._parser,
- "empty doc section '%s'" % self._section.name)
+ raise QAPISemError(
+ self._section.info,
+ "text required after '%s:'" % self._section.name)
self._section = new_section
@@ -748,7 +748,7 @@ def connect_member(self, member: 'QAPISchemaMember') -> None:
"%s '%s' lacks documentation"
% (member.role, member.name))
self.args[member.name] = QAPIDoc.ArgSection(self._parser,
- member.name)
+ '@' + member.name)
self.args[member.name].connect(member)
def connect_feature(self, feature: 'QAPISchemaFeature') -> None:
@@ -1 +1 @@
-doc-empty-section.json:7:1: empty doc section 'Note'
+doc-empty-section.json:6: text required after 'Note:'
Improve the message for an empty tagged section from empty doc section 'Note' to text required after 'Note:' and the message for an empty argument or feature description from empty doc section 'foo' to text required after '@foo:' Improve the error position to refer to the beginning of the empty section instead of its end. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240216145841.2099240-8-armbru@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/sphinx/qapidoc.py | 4 ++-- scripts/qapi/parser.py | 14 +++++++------- tests/qapi-schema/doc-empty-section.err | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-)