Auto-generate documentation for chplcheck lint rules #26208
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jabraham17
force-pushed
the
doc-lint-rules
branch
from
2de10a6 to
3cc699f
Compare
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
jabraham17
force-pushed
the
doc-lint-rules
branch
from
f7aeeba to
d9a845a
Compare
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
DanilaFe
approved these changes
Jan 7, 2025
tools/chplcheck/examples/PREDIFF
Outdated
There was a problem hiding this comment.
This looks like a copy of the PREDIFF elsewhere; can you symlink it instead?
There was a problem hiding this comment.
It is a copy. But tools/chplcheck/examples is included in the tarball while test/chplcheck/PREDIFF is not, so the tarball will have broken symlinks
| with context.track_errors() as _: | ||
| for loc, node, rule, fixits in driver.run_checks(context, asts): | ||
| diagnostic = Diagnostic( | ||
| range=chapel.lsp.location_to_range(loc), | ||
| message="Lint: rule [{}] violated".format(rule), | ||
| severity=DiagnosticSeverity.Warning, | ||
| code=rule, | ||
| code_description=CodeDescription(base_url + "#" + rule.lower()), |
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
DanilaFe
approved these changes
Jan 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
chplcheckrules, auto-generated from the existingchplcheckrule defintions.This PR makes the following changes:
make docswill now build arules.rstfile which is included in thechplcheckdocumentation 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 existschplchecklangauge server will provides a link straight to rule documentationFuture work:
tools/chplcheck/examples[Reviewed by @DanilaFe]