Skip to content

Documentation question: Order of messages #8321

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.

Sign up for GitHub

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

Jump to bottom
Closed
stdedos opened this issue Feb 21, 2023 · 2 comments · Fixed by #8326
Closed

Documentation question: Order of messages #8321

stdedos opened this issue Feb 21, 2023 · 2 comments · Fixed by #8326
Labels
Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@stdedos
Copy link
Contributor

stdedos commented Feb 21, 2023

Bug description

In #7162, "we decreed" that the Problem Code goes first, then the Correct Code

It seems that #8287 somehow reverted it? 😕

https://pylint.readthedocs.io/en/stable/user_guide/messages/warning/while-used.html (2.16.2)
image

https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/while-used.html (2.17.0-dev0)
image

Configuration

No response

Command used

.

Pylint output

.

Expected behavior

.

Pylint version

.

OS / Environment

No response

Additional dependencies

No response
@stdedos stdedos added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Feb 21, 2023
@stdedos
Copy link
Contributor Author

stdedos commented Feb 21, 2023

Perhaps

https://github.com/PyCQA/pylint/blob/899a7c595bca2936e89a87e8757c453bca687a24/doc/exts/pylint_messages.py#L87

return "\n".join((bad_code, good_code, pylintrc, details, related)) + "\n"

@DanielNoord
Copy link
Collaborator

This is correct. Would you want to open a PR to fix it?

@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Feb 21, 2023
@stdedos stdedos mentioned this issue Feb 22, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation: Order of messages stdedos/pylint
3 participants
@stdedos @Pierre-Sassoulas @DanielNoord