Auto-generate documentation for chplcheck lint rules #26208
Draft
+229
−14
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for
chplcheck
rules, auto-generated from the existingchplcheck
rule defintions.This PR makes the following changes:
make docs
will now build arules.rst
file which is included in thechplcheck
documentation which lists all lint rulesdoc/util/chplcheck-docs.py
, which is also available to users for their own custom rule filestools/chplcheck/examples
. These are included in the online docs and provide reasoning to users about why a lint rule existschplcheck
langauge server will provides a link straight to rule documentationTODO: document
doc/util/chplcheck-docs.py
TODO: make links more robust with version info
TODO: formatting of the rst
TODO: add more examples for rules and make sure those examples are run as tests
TODO: add settings info from #26190