Add the possible choices in the generated toml doc #8949
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the generated toml documentation.
Pierre-Sassoulas
added
Documentation 📗
Skip news 🔇
This was referenced Aug 13, 2023
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #8949 +/- ##
=======================================
Coverage 95.74% 95.74%
=======================================
Files 173 173
Lines 18557 18557
=======================================
Hits 17767 17767
Misses 790 790 |
mbyrnepr2
reviewed
Aug 13, 2023
| @@ -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.
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.valueThere was a problem hiding this comment.
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.
mbyrnepr2
approved these changes
Aug 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Changes
Description
New feature prior to #6736 and #8950