[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit
From: |
John Snow |
Subject: |
[PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit |
Date: |
Wed, 16 Dec 2020 20:53:43 -0500 |
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
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 428397a6954..8d5b8513fc8 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.
@@ -96,6 +97,13 @@ def __init__(self, value: _NodeT, 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 v3 01/13] qapi/introspect.py: assert schema is not None, (continued)
- [PATCH v3 01/13] qapi/introspect.py: assert schema is not None, John Snow, 2020/12/16
- [PATCH v3 02/13] qapi/introspect.py: use _make_tree for features nodes, John Snow, 2020/12/16
- [PATCH v3 06/13] qapi/introspect.py: replace 'extra' dict with 'comment' argument, John Snow, 2020/12/16
- [PATCH v3 04/13] qapi/introspect.py: guard against ifcond/comment misuse, John Snow, 2020/12/16
- [PATCH v3 05/13] qapi/introspect.py: Unify return type of _make_tree(), John Snow, 2020/12/16
- [PATCH v3 08/13] qapi/introspect.py: create a typed 'Annotated' data strutcure, John Snow, 2020/12/16
- [PATCH v3 09/13] qapi/introspect.py: improve _tree_to_qlit error message, John Snow, 2020/12/16
- [PATCH v3 10/13] qapi/introspect.py: improve readability of _tree_to_qlit, John Snow, 2020/12/16
- [PATCH v3 11/13] qapi/introspect.py: add type hint annotations, John Snow, 2020/12/16
- [PATCH v3 12/13] qapi/instrospect.py: add introspect.json dummy types, John Snow, 2020/12/16
- [PATCH v3 13/13] qapi/introspect.py: Add docstring to _tree_to_qlit,
John Snow <=
- [PATCH v3 07/13] qapi/introspect.py: Introduce preliminary tree typing, John Snow, 2020/12/16