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

Autogenerate error and warning documents from code #546

Open
kdahlquist opened this issue Oct 25, 2017 · 0 comments
Open

Autogenerate error and warning documents from code #546

kdahlquist opened this issue Oct 25, 2017 · 0 comments

Comments

@kdahlquist
Copy link
Collaborator

Once our warning and error data structures are standardized, it will be possible to write scripts that auto-catalog our errors so that documentation is not duplicated (e.g., https://github.com/dondi/GRNsight/wiki/Errors-Glossary, https://github.com/dondi/GRNsight/wiki/Warnings-Glossary, https://github.com/dondi/GRNsight/wiki/Error-Sort, etc.). We should do that eventually.

This automation will also help us do an audit of errors and warnings in the code base. Also, if warnings change to errors and vice versa, this would make it really easy to update our documented listings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants