-
-
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 a configuration file in documentation example for message #7143
Comments
We should do #7144 (comment), right after this is implemented. |
As a side issue, is there some explicit reason that "Correct code" appears before "Problematic code"? 😕 For the example of https://pylint.pycqa.org/en/latest/user_guide/messages/warning/while-used.html, I am expecting to see what my problem is (so as to make sure it matches my situation), not what the solution is (to a problem that hasn't been defined yet). |
@DanielNoord I also think that having the bad code first would be more intuitive, because you come to see what the issue is about then for the solution, what do you think ? |
Fine with me! @stdedos Is this something you would like to contribute to the project? Switching these two lines around should do the trick 😄 |
It makes more sense to _first define the problem_, then solve it. Mentions issue pylint-dev#7143 Signed-off-by: Stavros Ntentos <[email protected]>
Well, since you are so kind to pinpoint me exactly where to make the fix ... 😄 |
It makes more sense to _first define the problem_, then solve it. Mentions issue pylint-dev#7143 Signed-off-by: Stavros Ntentos <[email protected]>
It makes more sense to _first define the problem_, then solve it. Mentions issue #7143 Signed-off-by: Stavros Ntentos <[email protected]> Co-authored-by: Pierre Sassoulas <[email protected]>
Current problem
Right now we do not show the configuration used for example. We could and it would:
Desired solution
Show the configuration used in bad/good and use it as an example of configuration related to a message. There's some issue with this:
It's not easy to determine that without reading the code, we struggle as much as user here.
If the default value is 120 we need a way to show what it is if we change it to 15.
We already have a message for extensions right now.
Additional context
Initially discussed in #7142 (review)
The text was updated successfully, but these errors were encountered: