[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 11/11] qapi/introspect.py: Add docstring to _tree_to_qlit
From: |
John Snow |
Subject: |
[PATCH v2 11/11] qapi/introspect.py: Add docstring to _tree_to_qlit |
Date: |
Mon, 26 Oct 2020 15:42:51 -0400 |
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/introspect.py | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index d4f28485ba5..8db9650adbc 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -1,10 +1,11 @@
"""
QAPI introspection generator
-Copyright (C) 2015-2018 Red Hat, Inc.
+Copyright (C) 2015-2020 Red Hat, Inc.
Authors:
Markus Armbruster <armbru@redhat.com>
+ John Snow <jsnow@redhat.com>
This work is licensed under the terms of the GNU GPL, version 2.
See the COPYING file in the top-level directory.
@@ -90,6 +91,13 @@ def __init__(self, value: _AnnoType, ifcond: Iterable[str],
def _tree_to_qlit(obj: TreeValue, level: int = 0,
suppress_first_indent: bool = False) -> str:
+ """
+ Convert the type tree into a QLIT C string, recursively.
+
+ :param obj: The value to convert.
+ :param level: The indentation level for this particular value.
+ :param suppress_first_indent: True for dict value children.
+ """
def indent(level: int) -> str:
return level * 4 * ' '
--
2.26.2
- [PATCH v2 00/11] qapi: static typing conversion, pt2, John Snow, 2020/10/26
- [PATCH v2 02/11] [DO-NOT-MERGE] docs/sphinx: change default role to "any", John Snow, 2020/10/26
- [PATCH v2 11/11] qapi/introspect.py: Add docstring to _tree_to_qlit,
John Snow <=
- [PATCH v2 04/11] qapi/introspect.py: add assertions and casts, John Snow, 2020/10/26
- [PATCH v2 03/11] [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi, John Snow, 2020/10/26
- [PATCH v2 06/11] qapi/introspect.py: add _gen_features helper, John Snow, 2020/10/26
- [PATCH v2 08/11] qapi/introspect.py: replace 'extra' dict with 'comment' argument, John Snow, 2020/10/26
- [PATCH v2 07/11] qapi/introspect.py: Unify return type of _make_tree(), John Snow, 2020/10/26
- [PATCH v2 10/11] qapi/introspect.py: improve readability of _tree_to_qlit, John Snow, 2020/10/26
- [PATCH v2 01/11] [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick (``), John Snow, 2020/10/26
- [PATCH v2 09/11] qapi/introspect.py: create a typed 'Annotated' data strutcure, John Snow, 2020/10/26
- [PATCH v2 05/11] qapi/introspect.py: add preliminary type hint annotations, John Snow, 2020/10/26