[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 05/18] sphinx/qapidoc: Drop code to generate doc for simple union
From: |
Markus Armbruster |
Subject: |
[PULL 05/18] sphinx/qapidoc: Drop code to generate doc for simple union tag |
Date: |
Mon, 12 Feb 2024 10:14:23 +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>
Message-ID: <20240205074709.3613229-6-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@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
- [PULL 00/18] QAPI patches patches for 2024-02-12, Markus Armbruster, 2024/02/12
- [PULL 09/18] qga/qapi-schema: Plug trivial documentation holes, Markus Armbruster, 2024/02/12
- [PULL 05/18] sphinx/qapidoc: Drop code to generate doc for simple union tag,
Markus Armbruster <=
- [PULL 13/18] qapi: Improve documentation of file descriptor socket addresses, Markus Armbruster, 2024/02/12
- [PULL 03/18] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup, Markus Armbruster, 2024/02/12
- [PULL 01/18] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y, Markus Armbruster, 2024/02/12
- [PULL 02/18] docs/devel/qapi-code-gen: Tweak doc comment whitespace, Markus Armbruster, 2024/02/12
- [PULL 04/18] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/02/12
- [PULL 14/18] qapi: Move @String out of common.json to discourage reuse, Markus Armbruster, 2024/02/12
- [PULL 18/18] MAINTAINERS: Cover qapi/stats.json, Markus Armbruster, 2024/02/12
- [PULL 07/18] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks, Markus Armbruster, 2024/02/12
- [PULL 12/18] qapi: Plug trivial documentation holes around former simple unions, Markus Armbruster, 2024/02/12
- [PULL 06/18] qapi: Require member documentation (with loophole), Markus Armbruster, 2024/02/12