Issue #7531: doc: added warning about AST changes with comment-aware checks#18675
Merged
romani merged 1 commit intoJan 25, 2026
Merged
Conversation
Member
|
Please keep issue number as prefix |
Member
|
GitHub, generate website |
…ent-aware checks
c887023 to
eb5bb97
Compare
Contributor
Author
Member
|
GitHub, generate website |
Contributor
Author
|
Hi @romani, checking in to see if the generated docs look coorect to you. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
fixes #7531
this PR updates the documentation to warn users that enabling "comment-aware" checks (like TodoComment) changes the structure of the abstract syntax tree (AST) by inserting comment nodes.
Changes:
1 ) Command Line Usage (cmdline.xml.vm): Added a note in the "Generating XPath Suppressions XML" section.
2) Filters (suppressionxpathfilter.xml): Added an "Attention" note in the SuppressionXpathFilter documentation.