[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 20/34] qapi/events.py: Move comments into docstrings
From: |
Markus Armbruster |
Subject: |
[PULL 20/34] qapi/events.py: Move comments into docstrings |
Date: |
Sat, 10 Oct 2020 11:54:50 +0200 |
From: John Snow <jsnow@redhat.com>
Clarify them while we're here.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Message-Id: <20201009161558.107041-21-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/events.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/events.py b/scripts/qapi/events.py
index 57e0939e96..599f3d1f56 100644
--- a/scripts/qapi/events.py
+++ b/scripts/qapi/events.py
@@ -44,8 +44,12 @@ def gen_event_send_decl(name: str,
proto=build_event_send_proto(name, arg_type, boxed))
-# Declare and initialize an object 'qapi' using parameters from build_params()
def gen_param_var(typ: QAPISchemaObjectType) -> str:
+ """
+ Generate a struct variable holding the event parameters.
+
+ Initialize it with the function arguments defined in `gen_event_send`.
+ """
assert not typ.variants
ret = mcgen('''
%(c_name)s param = {
--
2.26.2
- [PULL 14/34] qapi/common.py: check with pylint, (continued)
- [PULL 14/34] qapi/common.py: check with pylint, Markus Armbruster, 2020/10/10
- [PULL 10/34] qapi/common.py: Remove python compatibility workaround, Markus Armbruster, 2020/10/10
- [PULL 04/34] qapi: move generator entrypoint into package, Markus Armbruster, 2020/10/10
- [PULL 06/34] qapi: Remove wildcard includes, Markus Armbruster, 2020/10/10
- [PULL 27/34] qapi/gen.py: Remove unused parameter, Markus Armbruster, 2020/10/10
- [PULL 18/34] qapi: establish mypy type-checking baseline, Markus Armbruster, 2020/10/10
- [PULL 24/34] qapi/source.py: delint with pylint, Markus Armbruster, 2020/10/10
- [PULL 28/34] qapi/gen.py: update write() to be more idiomatic, Markus Armbruster, 2020/10/10
- [PULL 21/34] qapi/commands.py: Don't re-bind to variable of different type, Markus Armbruster, 2020/10/10
- [PULL 17/34] qapi/common.py: move build_params into gen.py, Markus Armbruster, 2020/10/10
- [PULL 20/34] qapi/events.py: Move comments into docstrings,
Markus Armbruster <=
- [PULL 23/34] qapi/source.py: add type hint annotations, Markus Armbruster, 2020/10/10
- [PULL 25/34] qapi/gen: Make _is_user_module() return bool, Markus Armbruster, 2020/10/10
- [PULL 29/34] qapi/gen.py: delint with pylint, Markus Armbruster, 2020/10/10
- [PULL 16/34] qapi/common.py: Convert comments into docstrings, and elaborate, Markus Armbruster, 2020/10/10
- [PULL 22/34] qapi/commands.py: add type hint annotations, Markus Armbruster, 2020/10/10
- [PULL 30/34] qapi/types.py: add type hint annotations, Markus Armbruster, 2020/10/10
- [PULL 26/34] qapi/gen.py: add type hint annotations, Markus Armbruster, 2020/10/10
- [PULL 33/34] qapi/visit.py: remove unused parameters from gen_visit_object, Markus Armbruster, 2020/10/10
- [PULL 34/34] qapi/visit.py: add type hint annotations, Markus Armbruster, 2020/10/10
- [PULL 09/34] qapi: add pylintrc, Markus Armbruster, 2020/10/10