Skip to content

codegen: mention Rust in the README #21047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
redsun82 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −5
Open

codegen: mention Rust in the README #21047

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions misc/codegen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Code generation suite

This directory contains the code generation suite used by the Swift extractor and the QL library. This suite will use
the abstract class specification of `schema.py` to generate:
This directory contains the code generation suite used by the Swift and Rust extractors and QL library. This suite will use
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the article "the" before "QL library" for proper grammar.

Suggested change
This directory contains the code generation suite used by the Swift and Rust extractors and QL library. This suite will use
This directory contains the code generation suite used by the Swift and Rust extractors and the QL library. This suite will use

Copilot uses AI. Check for mistakes.
the abstract class specification of a `schema` python module to generate:
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word "python" should be capitalized to "Python" as it refers to the programming language name.

Suggested change
the abstract class specification of a `schema` python module to generate:
the abstract class specification of a `schema` Python module to generate:

Copilot uses AI. Check for mistakes.

* the `dbscheme` file (see [`dbschemegen.py`](generators/dbschemegen.py))
* the QL generated code and when appropriate the corresponding stubs (see [`qlgen.py`](generators/qlgen.py))
* C++ tags and trap entries (see [`trapgen.py`](generators/trapgen.py))
* C++ structured classes (see [`cppgen.py`](generators/cppgen.py))
* QL language tests for testing the extractors (see [`qlgen.py`](generators/qlgen.py))
* [Swift] C++ tags and trap entries (see [`trapgen.py`](generators/trapgen.py))
* [Swift] C++ structured classes (see [`cppgen.py`](generators/cppgen.py))
* [Rust] Rust structured classes (see [`rustgen.py`](generators/rustgen.py))
* [Rust] Rust sources for extractor language tests extracted from the documentation snippets (see [`rusttestgen.py`](generators/rusttestgen.py))

An example `schema.py` [can be found in the Swift package](../../swift/schema.py).
Schemas [can be found in the Swift package](../../swift/schema.py) or [in the Rust one](../../rust/schema).

## Usage

Expand Down