qapi: Slightly clearer error message for invalid "Returns" section
authorMarkus Armbruster <armbru@redhat.com>
Tue, 27 Feb 2024 11:39:10 +0000 (12:39 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 4 Mar 2024 06:12:40 +0000 (07:12 +0100)
Change "'Returns:' is only valid for commands" to "'Returns' section
is only valid for commands".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-3-armbru@redhat.com>

scripts/qapi/parser.py
tests/qapi-schema/doc-invalid-return.err

index bfc47cf3cb2777e333afa8142aeb88ec9478fc16..e4c2259e3908bda366424138210f11c13d0c9c2c 100644 (file)
@@ -716,8 +716,9 @@ class QAPIDoc:
 
     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:
 
index 3d9e71c2b3a52dad4be42233789884dd3c076931..aafd57b135a9124c3b234156b4fa6c331c54c29f 100644 (file)
@@ -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