Skip to content
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

Message content style guide and revamp of offending messages #5496

Open
Pierre-Sassoulas opened this issue Dec 9, 2021 · 0 comments
Open
Labels
Discussion 🤔 Enhancement ✨ Improvement to a component Maintenance Discussion or action around maintaining pylint or the dev workflow Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@Pierre-Sassoulas
Copy link
Member

Pierre-Sassoulas commented Dec 9, 2021

Current problem

We're in the business of making error/warning message, as an authoritative tool our advice are sometime listened too closely and the code can become worse as a result. Having some guidelines would help.

Desired solution

Implement #746 and #3512 first, then create a style guide for message and review the legacy messages and what need to do to make them follow the style guide..

Additional context

https://www.pypy.org/posts/2021/12/error-message-style-guides.html

@cdce8p suggested this or something close in a comment that I can't find :)

@Pierre-Sassoulas Pierre-Sassoulas added Enhancement ✨ Improvement to a component Discussion 🤔 Maintenance Discussion or action around maintaining pylint or the dev workflow labels Dec 9, 2021
@Pierre-Sassoulas Pierre-Sassoulas added the Needs PR This issue is accepted, sufficiently specified and now needs an implementation label Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion 🤔 Enhancement ✨ Improvement to a component Maintenance Discussion or action around maintaining pylint or the dev workflow Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Development

No branches or pull requests

1 participant