Rust: add QL doc annotations to schema #17527
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
aibaars
force-pushed
the
aibaars/rust-annotations
branch
from
a7835ef to
eade815
Compare
redsun82
reviewed
Sep 20, 2024
rust/schema/annotations.py
Outdated
Comment on lines
173
to
183
| # @annotate(ConstExpr) | ||
| # @rust.doc_test_signature("() -> bool") | ||
| # class _: | ||
| # """ | ||
| # A `const` block expression. For example: | ||
| # ```rust | ||
| # if const { SRC::IS_ZST || DEST::IS_ZST || mem::align_of::<SRC>() != mem::align_of::<DEST>() } { | ||
| # return false; | ||
| # } | ||
| # ``` | ||
| # """ |
There was a problem hiding this comment.
why is this commented out? Might be worth a TODO unless it's an oversight
redsun82
reviewed
Sep 20, 2024
rust/schema/annotations.py
Outdated
| """ | ||
| The base class for expressions. | ||
| """ | ||
| pass |
There was a problem hiding this comment.
nit: pass is not required, and currently the file is not very consistent on it :)
redsun82
reviewed
Sep 20, 2024
rust/schema/annotations.py
Outdated
Comment on lines
540
to
558
| # @annotate(ElementListExpr) | ||
| # class _: | ||
| # """ | ||
| # An element list expression. For example: | ||
| # ```rust | ||
| # [1, 2, 3, 4, 5]; | ||
| # [1, 2, 3, 4, 5][0] = 6; | ||
| # ``` | ||
| # """ | ||
|
|
||
|
|
||
| # @annotate(RepeatExpr) | ||
| # class _: | ||
| # """ | ||
| # A repeat expression. For example: | ||
| # ```rust | ||
| # [1; 10]; | ||
| # ``` | ||
| # """ |
There was a problem hiding this comment.
I guess this is what because of what you mentioned on https://github.com/github/codeql-team/issues/3378, right?
There was a problem hiding this comment.
Yes, but I can remove this for now.
|
@redsun82 The QL test generator seems to ignore the function signatures somehow, did we break something in the schema generator? |
aibaars
force-pushed
the
aibaars/rust-annotations
branch
from
121d212 to
45d9d8a
Compare
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 pull request puts the QL docs with code examples back into the schema and generate the corresponding QL tests.