[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 24/46] qapi/events.py: Move comments into docstrings
From: |
John Snow |
Subject: |
[PATCH v4 24/46] qapi/events.py: Move comments into docstrings |
Date: |
Wed, 30 Sep 2020 00:31:28 -0400 |
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>
---
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 57e0939e963..599f3d1f564 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
- [PATCH v4 17/46] qapi/common.py: Replace one-letter 'c' variable, (continued)
- [PATCH v4 17/46] qapi/common.py: Replace one-letter 'c' variable, John Snow, 2020/09/30
- [PATCH v4 19/46] qapi/common.py: add type hint annotations, John Snow, 2020/09/30
- [PATCH v4 18/46] qapi/common.py: check with pylint, John Snow, 2020/09/30
- [PATCH v4 20/46] qapi/common.py: Convert comments into docstrings, and elaborate, John Snow, 2020/09/30
- [PATCH v4 25/46] qapi/commands.py: Don't re-bind to variable of different type, John Snow, 2020/09/30
- [PATCH v4 28/46] qapi/source.py: add type hint annotations, John Snow, 2020/09/30
- [PATCH v4 31/46] qapi/gen.py: add type hint annotations, John Snow, 2020/09/30
- [PATCH v4 21/46] qapi/common.py: move build_params into gen.py, John Snow, 2020/09/30
- [PATCH v4 23/46] qapi/events.py: add type hint annotations, John Snow, 2020/09/30
- [PATCH v4 22/46] qapi: establish mypy type-checking baseline, John Snow, 2020/09/30
- [PATCH v4 24/46] qapi/events.py: Move comments into docstrings,
John Snow <=
- [PATCH v4 26/46] qapi/commands.py: add type hint annotations, John Snow, 2020/09/30
- [PATCH v4 27/46] qapi/commands.py: enable checking with mypy, John Snow, 2020/09/30
- [PATCH v4 29/46] qapi/source.py: delint with pylint, John Snow, 2020/09/30
- [PATCH v4 30/46] qapi/gen.py: Fix edge-case of _is_user_module, John Snow, 2020/09/30
- [PATCH v4 34/46] qapi/gen.py: update write() to be more idiomatic, John Snow, 2020/09/30
- [PATCH v4 32/46] qapi/gen.py: Enable checking with mypy, John Snow, 2020/09/30
- [PATCH v4 33/46] qapi/gen.py: Remove unused parameter, John Snow, 2020/09/30
- [PATCH v4 35/46] qapi/gen.py: delint with pylint, John Snow, 2020/09/30
- [PATCH v4 36/46] qapi/introspect.py: assert obj is a dict when features are given, John Snow, 2020/09/30