Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support :meta hide-value: #99

Open
Tatsh opened this issue Sep 7, 2024 · 0 comments
Open

Support :meta hide-value: #99

Tatsh opened this issue Sep 7, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Tatsh
Copy link

Tatsh commented Sep 7, 2024

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

  • Operating System: Linux
  • Python: 3.12
  • enum_tools: 0.12.0
@Tatsh Tatsh added the enhancement New feature or request label Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants