[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 25/47] qapi/events.py: Move comments into docstrings
From: |
John Snow |
Subject: |
[PATCH v3 25/47] qapi/events.py: Move comments into docstrings |
Date: |
Thu, 24 Sep 2020 20:28:38 -0400 |
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 | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/events.py b/scripts/qapi/events.py
index 57e0939e96..9f868589bb 100644
--- a/scripts/qapi/events.py
+++ b/scripts/qapi/events.py
@@ -44,8 +44,10 @@ 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:
+ """
+ Declare and initialize a qapi object, using parameters from `build_params`.
+ """
assert not typ.variants
ret = mcgen('''
%(c_name)s param = {
--
2.26.2
- [PATCH v3 13/47] qapi: delint using flake8, (continued)
- [PATCH v3 13/47] qapi: delint using flake8, John Snow, 2020/09/24
- [PATCH v3 05/47] qapi/doc.py: Change code templates from function to string, John Snow, 2020/09/24
- [PATCH v3 15/47] qapi/common.py: Remove python compatibility workaround, John Snow, 2020/09/24
- [PATCH v3 20/47] qapi/common.py: add type hint annotations, John Snow, 2020/09/24
- [PATCH v3 17/47] qapi/common.py: delint with pylint, John Snow, 2020/09/24
- [PATCH v3 14/47] qapi: add pylintrc, John Snow, 2020/09/24
- [PATCH v3 24/47] qapi/events.py: add type hint annotations, John Snow, 2020/09/24
- [PATCH v3 19/47] qapi/common.py: check with pylint, John Snow, 2020/09/24
- [PATCH v3 23/47] qapi: establish mypy type-checking baseline, John Snow, 2020/09/24
- [PATCH v3 33/47] qapi/gen.py: Enable checking with mypy, John Snow, 2020/09/24
- [PATCH v3 25/47] qapi/events.py: Move comments into docstrings,
John Snow <=
- [PATCH v3 16/47] qapi/common.py: Add indent manager, John Snow, 2020/09/24
- [PATCH v3 22/47] qapi/common.py: move build_params into gen.py, John Snow, 2020/09/24
- [PATCH v3 35/47] qapi/gen.py: update write() to be more idiomatic, John Snow, 2020/09/24
- [PATCH v3 27/47] qapi/commands.py: add type hint annotations, John Snow, 2020/09/24
- [PATCH v3 36/47] qapi/gen.py: delint with pylint, John Snow, 2020/09/24
- [PATCH v3 21/47] qapi/common.py: Convert comments into docstrings, and elaborate, John Snow, 2020/09/24
- [PATCH v3 41/47] qapi/introspect.py: replace 'extra' dict with 'comment' argument, John Snow, 2020/09/24
- [PATCH v3 43/47] qapi/types.py: add type hint annotations, John Snow, 2020/09/24
- [PATCH v3 28/47] qapi/commands.py: enable checking with mypy, John Snow, 2020/09/24
- [PATCH v3 26/47] qapi/commands.py: Don't re-bind to variable of different type, John Snow, 2020/09/24