Rust: Fix examples in qldoc #20286
Merged
Rust: Fix examples in qldoc #20286
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
paldepind
force-pushed
the
rust/fix-examples
branch
from
b6bc202 to
c392706
Compare
paldepind
force-pushed
the
rust/fix-examples
branch
from
c392706 to
17f7b7f
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR fixes invalid Rust code examples in QLdoc comments across multiple files. The changes correct syntax errors where bracket indexing was incorrectly applied to tuples and structs, and where assignments lacked proper assignee expressions.
Key changes:
- Replace invalid bracket indexing syntax with proper field access and destructuring
- Add missing variable declarations and proper assignment patterns
- Update generated file checksums to reflect the documentation changes
Reviewed Changes
Copilot reviewed 6 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| rust/schema/annotations.py | Updates QLdoc examples for struct and tuple expressions with valid Rust syntax |
| rust/ql/lib/codeql/rust/elements/internal/TupleExprImpl.qll | Fixes tuple expression documentation examples |
| rust/ql/lib/codeql/rust/elements/internal/StructExprImpl.qll | Fixes struct expression documentation examples |
| rust/ql/lib/codeql/rust/elements/TupleExpr.qll | Updates tuple expression documentation |
| rust/ql/lib/codeql/rust/elements/StructExpr.qll | Updates struct expression documentation |
| rust/ql/.generated.list | Updates checksums for generated files after documentation changes |
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.
Tweaks some examples in QLdoc to be valid Rust.
[..]indexing does not work on tuples or structs.