-
Notifications
You must be signed in to change notification settings - Fork 37
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
Enable rstcheck
in CI and lint code blocks
#498
Conversation
dbaae2c
to
0645695
Compare
0645695
to
6918973
Compare
@ml-evs This is marked as a draft, but is it not good to go now? The GitHub pre-commit checks pass and seem to include rstcheck. (That said, in some future cleanup I would like to just float if it is possible to move these checks into 'make audit' instead, and then only have a single 'make audit' in the pre-commit hooks. That makes it a bit more straightforward to keep the pre-commit hooks aligned with the checks it is easy to do oneself when working on a clone, and it would also avoid us becoming unnecessarily dependent on git-specific features.) |
In that case, feel free to review and we can merge here. Otherwise also happy to use |
Co-authored-by: Antanas Vaitkus <antanas.vaitkus90@gmail.com>
This PR follows up on #493 by following GitHub's advice of running the spec through
rstcheck
. We were already passing it, but in the process of adding it I think it makes sense to properly lint our code blocks as JSON data (which is possible in many cases without losing the structure of them).Also this PR:
..
".meta
example)Unfortunately its a bit tricky to see how this will render in the future in GitHub, so perhaps we need to hold off a little while for the official response.