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

Choose a sensible naming/numbering scheme for errors #1

Closed
suchow opened this issue Jan 14, 2015 · 0 comments
Closed

Choose a sensible naming/numbering scheme for errors #1

suchow opened this issue Jan 14, 2015 · 0 comments

Comments

@suchow
Copy link
Member

suchow commented Jan 14, 2015

The convention is a capital letter and a 3 digit code. For example, pep257 uses codes like D100, D302, etc. It might be nice for us to use a 3-letter code for the source of the advice and a 3-digit code for the specific check, e.g., DFW201. The numeric codes can then be organized across sources according to higher-level categories of errors. For example, 100-level codes might be for overused words, phrases, idioms, symbols, and grammatical structures. The 200-level codes might be for nonsensical structures, such as DFW's comparing uncomparables. This fails if a particular author has > 99 pieces of advice of a particular kind, but if we run into that problem, then we're doing great. If that happens it might also suggest that our errors could use some compression (e.g., by merging all the overused single words into one check).

The URLs it leads to are nice and compact, too: http://lifelinter.com/DFW201.

@suchow suchow added this to the v1.0.0 milestone Jan 14, 2015
@suchow suchow closed this as completed in 1d04a85 Mar 25, 2015
suchow pushed a commit that referenced this issue Sep 25, 2015
suchow pushed a commit that referenced this issue Sep 25, 2015
suchow pushed a commit that referenced this issue Sep 27, 2015
suchow pushed a commit that referenced this issue Sep 27, 2015
suchow pushed a commit that referenced this issue Sep 27, 2015
suchow pushed a commit that referenced this issue Sep 27, 2015
suchow pushed a commit that referenced this issue Sep 27, 2015
suchow added a commit that referenced this issue Sep 27, 2015
suchow added a commit that referenced this issue Sep 27, 2015
suchow added a commit that referenced this issue Sep 27, 2015
suchow added a commit that referenced this issue Sep 27, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
laraross added a commit that referenced this issue Sep 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant