-
Notifications
You must be signed in to change notification settings - Fork 273
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
Add linting following styleguide #1027
Conversation
The styleguide needs to be excluded as it explicitly does not follow the styleguide. |
linter reports 3482 errors. |
For right now, can it be added to run as diffs that way we can slowly migrate as things get updated. |
I think that should do it? |
Does this exclude code? |
doc8 uses docutils directly so deleting code files shouldn't matter. Just in case, I changed it to only delete rst files. |
I meant, for example, if a there's two consecutive new lines within a .. code:: directive, would this flag it? |
code directives are excluded from all checks except for the two consecutive lines test. I had accounted for code-blocks and code-tabs but forgot about regular old code. I fixed that now. |
Is there a way to disable a specific linter for a block? |
If you're asking if there are pre-processor flags of sort that allow users to disable linting for blocks, then no. I think that any excluded blocks should be hardcoded into the checks. |
Removed the linter source and updated ci to use ohnoyoudidnt |
Adds a linter package that extends doc8 to add tests for conformity to the stricter frc-docs styleguide.
Checks included:
todo: add list supportdone)Testing
I wrote all the boilerplate required for testing.
Tests are welcome.
Future
This linter finds many issues in frc-docs. They should go in a separate PR once this one is finalized to reduce clutter.