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

Document why each issue is a problem #51

Open
dburgener opened this issue Mar 13, 2020 · 0 comments
Open

Document why each issue is a problem #51

dburgener opened this issue Mar 13, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dburgener
Copy link
Member

We have the one line descriptions of each issue in the analysis output and the README, and we have (not fully updated) examples in check_examples.txt, but I don't think there's anywhere with more fully fleshed out documentation about why each of these things is bad and what should be done to correct them. Depending on the check (ordering), some more thorough documentation about how it works might also be helpful. The wiki would probably be a good place for this info.

@dburgener dburgener added the documentation Improvements or additions to documentation label Mar 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant