Skip to content

Reference Enums rather than describing the specific values. #191

@dalonsoa

Description

@dalonsoa

This "with valid values..." comment is made in multiple docstrings and is essentially just referencing the values in the Enum used. If these Enums ever change these docstring will also need to be updated, which can easily be missed. Maybe it's best to just reference the Enum? This can be done quite seamlessly with a link in the docs if we're using mkdocstrings.

Originally posted by @AdrianDAlessandro in #125 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions