[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 05/15] sphinx/qapidoc: Drop code to generate doc for simple union
From: |
Markus Armbruster |
Subject: |
[PATCH 05/15] sphinx/qapidoc: Drop code to generate doc for simple union tag |
Date: |
Mon, 5 Feb 2024 08:46:59 +0100 |
QAPISchemaGenRSTVisitor._nodes_for_members() has a special case to
auto-generate documentation for a union tag member of implicit (enum)
type that lacks documentation.
This was useful for simple unions, where the tag member's type was
implicitly. The only implicit enum type left today is 'QType'. Not
worth a special case. Drop. No change to generated documentation.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/sphinx/qapidoc.py | 6 ------
1 file changed, 6 deletions(-)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 658c288f8f..05b809af27 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -168,12 +168,6 @@ def _nodes_for_members(self, doc, what, base=None,
variants=None):
# TODO drop fallbacks when undocumented members are outlawed
if section.text:
defn = section.text
- elif (variants and variants.tag_member == section.member
- and not section.member.type.doc_type()):
- values = section.member.type.member_names()
- defn = [nodes.Text('One of ')]
- defn.extend(intersperse([nodes.literal('', v) for v in values],
- nodes.Text(', ')))
else:
defn = [nodes.Text('Not documented')]
--
2.43.0
- Re: [PATCH 06/15] qapi: Require member documentation (with loophole), (continued)
- [PATCH 10/15] qapi/yank: Clean up documentaion of yank, Markus Armbruster, 2024/02/05
- [PATCH 14/15] qapi: Move @String out of common.json to discourage reuse, Markus Armbruster, 2024/02/05
- [PATCH 12/15] qapi: Plug trivial documentation holes around former simple unions, Markus Armbruster, 2024/02/05
- [PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks, Markus Armbruster, 2024/02/05
- [PATCH 05/15] sphinx/qapidoc: Drop code to generate doc for simple union tag,
Markus Armbruster <=
- [PATCH 13/15] qapi: Improve documentation of file descriptor socket addresses, Markus Armbruster, 2024/02/05
- [PATCH 01/15] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y, Markus Armbruster, 2024/02/05
- [PATCH 09/15] qga/qapi-schema: Plug trivial documentation holes, Markus Armbruster, 2024/02/05
- Re: [PATCH 00/15] qapi: Require member documentation (with loophole), Peter Xu, 2024/02/06