Shared: Add elaborate QL doc to TypeInference.qll
#19727
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR expands the documentation in TypeInference.qll with detailed examples and descriptions of the two-phase initialization (Make1/Make2), the Matching and IsInstantiationOf modules, and usage patterns for the inferType predicate.
- Added
IsInstantiationOfto the phases overview. - Introduced multiple C#-style code examples illustrating base and recursive cases.
- Expanded explanation of the
Matchingmodule usage for generic methods.
Comments suppressed due to low confidence (2)
shared/typeinference/codeql/typeinference/internal/TypeInference.qll:11
- Grammar: add "to" after "is" so it reads "is to define a predicate".
* The intended use of this library is define a predicate
shared/typeinference/codeql/typeinference/internal/TypeInference.qll:94
- Formatting: remove the stray
"afterpath.isEmptyand add()to match other examples (i.e.,path.isEmpty()).
* // at argument position `0` is `int` with `path.isEmpty"`"
shared/typeinference/codeql/typeinference/internal/TypeInference.qll
Outdated
Show resolved
Hide resolved
…ce.qll Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
geoffw0
previously approved these changes
Jun 12, 2025
shared/typeinference/codeql/typeinference/internal/TypeInference.qll
Outdated
Show resolved
Hide resolved
…ce.qll Co-authored-by: Geoffrey White <40627776+geoffw0@users.noreply.github.com>
geoffw0
approved these changes
Jun 12, 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.
No description provided.