-
-
Notifications
You must be signed in to change notification settings - Fork 48
Closed
Labels
extractor: griffeRelated to griffeRelated to griffefeatureNew feature or requestNew feature or requesttemplatesJinja templatesJinja templates
Description
Description of the bug
The ENUM render isn't rendering the ENUM name in the value.
To Reproduce
- Create an enum:
class MyEnum(Enum):
"""Just a ENUM example"""
MY_VALUE_1 = 1
MY_VALUE_2 = 2
- Reference the ENUM value in a field:
MY_FIELD = MyEnum.MY_VALUE_1.value
MY_FIELD_ARRAY = [ MyEnum.MY_VALUE_1.value, MyEnum.MY_VALUE_2.value ]
- Generate the doc.
Expected behavior
For ENUM values the ENUM name/full qualified name helps to gather context, it should render at least the ENUM name in the value, like MyEnum.MY_VALUE_1.value
, the constant MY_VALUE_1.value
or the full qualified name my_module.MyEnum.MY_VALUE_1.value
.
Metadata
Metadata
Assignees
Labels
extractor: griffeRelated to griffeRelated to griffefeatureNew feature or requestNew feature or requesttemplatesJinja templatesJinja templates