Repository navigation
Shared: Add missing QLDoc in variable capture library - #22955
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only change addresses missing QLDoc comments for variable-capture APIs and consistency checks, with no active review issues identified.
No open issues 🎉
What changed in this PR
This documentation-only pull request adds missing QLDoc comments to the shared variable-capture library, helping prevent documentation-related CI failures for new language integrations.
Changes:
- Documents the
BasicBlockandSynthesizedCaptureNodehelper APIs. - Documents the
ConsistencyChecksmodule and its validation predicates. - Clarifies the behavior and parameters of variable-capture consistency checks.
| File | Description |
|---|---|
shared/dataflow/codeql/dataflow/VariableCapture.qll |
Adds QLDoc comments for variable-capture APIs and consistency checks. |
Review effort: Lite (auto)
aschackmull
approved these changes
Oct 30, 2026
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
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.
This avoids CI failures for PRs implementing this library for new languages.