-
-
Notifications
You must be signed in to change notification settings - Fork 160
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
Validating Enum doc-strings? #458
Comments
There is nothing specific to Enums in the standard, so I suppose they follow the class docstring recommendations. Note that some of the validation checks are extra nit-picky and are not actually part of the standard - they're more just a way to help users enforce a uniform docstring format, should they choose to do so. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Not sure if it is just me, but I get the following warning when validating an Enum:
The code looks like:
Is there a more correct way to document enums or is this just something that is not completely covered in the validation?
Edit: I should mention that I have tried several different ways to format the doc-string as well.
The text was updated successfully, but these errors were encountered: