Mention Pylint's symbolic names along with message ids #76
Conversation
This file contains hidden or 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
Pylint tries to move away from using numeric message ids for its errors and warnings, since they can not be easily remembered, slowly becoming a second class citizen. Instead, Pylint uses symbolic names, which don't carry as much information as the numerical ids, but they can be remembered easily and carry a semantic meaning due to their natural language expresiveness. Also, this patch removes the mentions to wikidot, since it's not sanctioned by pylint as an official source of documentation, its use being an artifact from pylint's past.
Contributor
|
Hi, thanks for your commit. Do we really have to remove the links? I know the messages change, but referencing the message descriptions would be nice. |
Contributor
Author
|
We could leave them as is for now, even though they aren't officially sanctioned by Pylint. On the other hand, I could link up pylint's documentation instead, but unfortunately it's not so user friendly and I can't give a link to individual message descriptions. What do you think we should do? |
Contributor
|
Let's just stick to your commit ;-) |
programmdesign
added a commit
that referenced
this pull request
Sep 22, 2015
Mention Pylint's symbolic names along with message ids
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hi,
A small Pylint related issue.
We're trying to move away from using numeric message ids for errors and warnings, since they can not be easily remembered, slowly becoming a second class citizen. Instead, Pylint uses symbolic names, which don't carry as much information as the numerical ids (from what checker they're coming for instance), but they can be remembered easily and carry a semantic meaning due to their natural language expressiveness.
Also, this patch removes the mentions to wikidot, since it's not sanctioned by Pylint as an official source of documentation, its use being an artifact from Pylint's past.