| Message ID | 20240205074709.3613229-6-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Require member documentation (with loophole) | expand |
On Mon, Feb 05, 2024 at 08:46:59AM +0100, Markus Armbruster wrote: > 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(-) Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> With regards, Daniel
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')]
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(-)