Skip to content

Listing enumerations in the generated docs #633

Closed Answered by pawamoy
claudio-alvaro-wbgames asked this question in Q&A
Discussion options

You must be logged in to vote

Each value is an attribute of the class, so you can either document them, or set show_if_no_docstring: true for the class.

class MyEnum(enum.Enum):
    """Docs for the class."""
    A = 0
    """Docs for A."""
    B = 1
    """Docs for B."""
    C = 2
    """Docs for C."""

Replies: 1 comment 1 reply

Comment options

You must be logged in to vote
1 reply
@claudio-alvaro-wbgames
Comment options

Answer selected by pawamoy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
None yet
2 participants