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.

Sign up for GitHub

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

Jump to bottom

Reference Enums rather than describing the specific values. #191

Open

dalonsoa opened this issue Jan 24, 2025 · 0 comments

Labels

Collaborator

dalonsoa commented Jan 24, 2025

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)

dalonsoa added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment