[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 20/36] qapi/events.py: Move comments into docstrings
From: |
John Snow |
Subject: |
[PATCH v6 20/36] qapi/events.py: Move comments into docstrings |
Date: |
Fri, 9 Oct 2020 12:15:42 -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 v6 08/36] qapi: delint using flake8, (continued)
- [PATCH v6 08/36] qapi: delint using flake8, John Snow, 2020/10/09
- [PATCH v6 06/36] qapi: Remove wildcard includes, John Snow, 2020/10/09
- [PATCH v6 05/36] qapi: Prefer explicit relative imports, John Snow, 2020/10/09
- [PATCH v6 07/36] qapi: enforce import order/styling with isort, John Snow, 2020/10/09
- [PATCH v6 09/36] qapi: add pylintrc, John Snow, 2020/10/09
- [PATCH v6 10/36] qapi/common.py: Remove python compatibility workaround, John Snow, 2020/10/09
- [PATCH v6 11/36] qapi/common.py: Add indent manager, John Snow, 2020/10/09
- [PATCH v6 12/36] qapi/common.py: delint with pylint, John Snow, 2020/10/09
- [PATCH v6 13/36] qapi/common.py: Replace one-letter 'c' variable, John Snow, 2020/10/09
- [PATCH v6 15/36] qapi/common.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 20/36] qapi/events.py: Move comments into docstrings,
John Snow <=
- [PATCH v6 16/36] qapi/common.py: Convert comments into docstrings, and elaborate, John Snow, 2020/10/09
- [PATCH v6 14/36] qapi/common.py: check with pylint, John Snow, 2020/10/09
- [PATCH v6 17/36] qapi/common.py: move build_params into gen.py, John Snow, 2020/10/09
- [PATCH v6 19/36] qapi/events.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 18/36] qapi: establish mypy type-checking baseline, John Snow, 2020/10/09
- [PATCH v6 23/36] qapi/commands.py: enable checking with mypy, John Snow, 2020/10/09
- [PATCH v6 24/36] qapi/source.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 26/36] qapi/gen.py: Fix edge-case of _is_user_module, John Snow, 2020/10/09