-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Add the possible choices in the generated toml doc #8949
Add the possible choices in the generated toml doc #8949
Conversation
In the generated toml documentation.
@@ -538,10 +538,12 @@ Standard Checkers | |||
.. code-block:: toml | |||
|
|||
[tool.pylint.basic] | |||
# Possible choices: ['snake_case', 'camelCase', 'PascalCase', 'UPPER_CASE', 'any'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps these could be enums - making the possible values a bit easier to maintain?
for example:
from enum import StrEnum
class NamingStyle(StrEnum):
SNAKE_CASE: "snake_case"
CAMEL_CASE: "camelCase"
...
attr-naming-style = NamingStyle.SNAKE_CASE.value
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's do a refactor in another MR if necessary but I think it's internal so only pylint dev are using this and I feel like it's working well enough.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. One suggestion but could leave it out or separate that into a follow-up also.
Type of Changes
Description
New feature prior to #6736 and #8950