Skip to content
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.

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

Rust: give more options for building in README.md #18468

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

redsun82
Copy link
Contributor

No description provided.

@Copilot Copilot bot review requested due to automatic review settings January 10, 2025 10:46

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more

@github-actions github-actions bot added documentation Rust Pull requests that update Rust code labels Jan 10, 2025
Copy link
Contributor

@paldepind paldepind left a comment

Choose a reason for hiding this comment

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

Really nice to have better docs 😃

I've left a few minor comments.

@@ -40,4 +48,17 @@ TODO

### Code Generation

TODO
If you do changes to either
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you do changes to either
If you make changes to either

@@ -40,4 +48,17 @@ TODO

### Code Generation

TODO
If you do changes to either
* `ast-generator`, or
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps this will make it a bit clearer that it's talking about a directory?

Suggested change
* `ast-generator`, or
* `ast-generator/`, or

* `schema/*.py`

you'll need to regenerate code. You can do so running
```bash
Copy link
Contributor

Choose a reason for hiding this comment

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

Mega nitpick, but I think it's cleaner to use sh for things that works in any shell and not just Bash.

Suggested change
```bash
```sh

```

Sometimes, especially if resolving conflicts on generated files, you might need to run
```bash
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```bash
```sh


Sometimes, especially if resolving conflicts on generated files, you might need to run
```bash
bazel run @codeql//rust/codegen -- --force
Copy link
Contributor

Choose a reason for hiding this comment

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

Really great to have this documented 👍. I struggled with that until I found the --force flag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Rust Pull requests that update Rust code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants