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.

Sign up for GitHub

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

Jump to bottom

Generate documentation from the inspections #337

Open
mwz opened this issue Mar 31, 2020 · 1 comment
Open

Generate documentation from the inspections #337

mwz opened this issue Mar 31, 2020 · 1 comment

Comments

@mwz
Copy link
Contributor

mwz commented Mar 31, 2020

Since all the inspections now have up-to-date metadata, which is accessible from the code, we can automate generating documentation that could replace the
inspections section in the readme file https://github.com/sksamuel/scapegoat#inspections.

Probably a separate markdown page that could be linked from the readme would be the easiest thing to start with.
@mwz
Copy link
Contributor Author

mwz commented May 25, 2020 •
edited
Loading

I might take a look at this.
Does anyone have any thoughts, e.g. are you ok with generating a separate markdown page with a list of inspections? Something similar to the existing format (a table) would probably work fine for now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mwz