domdfcoding / enum_tools

Tools to expand Python's enum module.
https://enum-tools.readthedocs.io/en/latest
GNU Lesser General Public License v3.0
8 stars 7 forks source link

Support :meta hide-value: #99

Open Tatsh opened 2 months ago

Tatsh commented 2 months ago

Description

Reference

Even with document_enum() decorator, :meta hide-value: is not respected. I think this should be supported. I do not have a reason to show the enumeration values 99% of the time.

@document_enum()
class SomeEnum(Enum):
    """
    Document this enum.

    :meta hide-value:
    """
    X = 1
    """Value for something."""

Could also be done at the enum value level, but most of the time I would want this at the top level comment and therefore not requiring @document_enum.

Version