diff mbox series

[02/13] qapi: Slightly clearer error message for invalid "Returns" section

Message ID 20240227113921.236097-3-armbru@redhat.com
State New
Headers show
Series Subject: [PATCH 00/15] qapi: Improve command response documentation | expand

Commit Message

Markus Armbruster Feb. 27, 2024, 11:39 a.m. UTC
Change "'Returns:' is only valid for commands" to "'Returns' section
is only valid for commands".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi/parser.py                   | 5 +++--
 tests/qapi-schema/doc-invalid-return.err | 2 +-
 2 files changed, 4 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index bfc47cf3cb..e4c2259e39 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -716,8 +716,9 @@  def connect_feature(self, feature: 'QAPISchemaFeature') -> None:
 
     def check_expr(self, expr: QAPIExpression) -> None:
         if self.returns and 'command' not in expr:
-            raise QAPISemError(self.returns.info,
-                               "'Returns:' is only valid for commands")
+            raise QAPISemError(
+                self.returns.info,
+                "'Returns' section is only valid for commands")
 
     def check(self) -> None:
 
diff --git a/tests/qapi-schema/doc-invalid-return.err b/tests/qapi-schema/doc-invalid-return.err
index 3d9e71c2b3..aafd57b135 100644
--- a/tests/qapi-schema/doc-invalid-return.err
+++ b/tests/qapi-schema/doc-invalid-return.err
@@ -1 +1 @@ 
-doc-invalid-return.json:6: 'Returns:' is only valid for commands
+doc-invalid-return.json:6: 'Returns' section is only valid for commands