I understand that I can add a Python docstring to an enum type as I would any other class. But how do I add documentation to an element of that type?
As far as I can see there are three possibilities:
class MyEnum(Enum):
"""
This is my enum type.
"""
"""
Variant 1
"""
a = 0,
b = 1, # variant 2
c = 2, """ variant 3 """
But none of them really work consistently.
If I call print(inspect.getdoc(MyEnum.a))
in any of the variants, the docstring of the MyEnum
type is returned ('This is my enum type'). Pycharm can show variant 3 in its Quick Documentation preview, but includes the quotes and longer comments that exceed the column wrap will not be shown correctly.
Is there a preferred way or convention on how to document Python enum elements?