search

quantifiedcode / python-anti-patterns

An open collection of Python anti-patterns and worst practices.
https://quantifiedcode.github.io/python-anti-patterns
Other
1.71k stars 249 forks source link

Mention Pylint's symbolic names along with message ids #76

Closed PCManticore closed 9 years ago

PCManticore commented 9 years ago

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.

programmdesign commented 9 years ago

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.

PCManticore commented 9 years ago

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?

programmdesign commented 9 years ago

Let's just stick to your commit ;-)