manual: Document all rust-project.json fields #18878
Merged
Conversation
This file contains 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
rustbot
added
the
S-waiting-on-review
lnicola
reviewed
Jan 8, 2025
docs/user/manual.adoc
Outdated
| args: string[]; | ||
| /// The current working directory of the runnable. | ||
| cwd: string; | ||
| kind: 'check' | 'run' | 'testOne'; |
There was a problem hiding this comment.
I think testOne is the only value that's used when you have a rust-project.json, so I've documented that and removed the other mentions.
Wilfred
force-pushed
the
document_build_info
branch
from
9db9b53 to
6ab6084
Compare
lnicola
reviewed
Jan 10, 2025
docs/user/manual.adoc
Outdated
| args: string[]; | ||
| /// The current working directory of the runnable. | ||
| cwd: string; | ||
| /// Used to decide what CodeLens to offer. |
There was a problem hiding this comment.
Suggested change
| /// Used to decide what CodeLens to offer. | |
| /// Used to decide what code lens to offer. |
There was a problem hiding this comment.
Updated. FWIW VS Code uses this capitalisation, but I agree that 'code lens' reads more nicely here.
lnicola
reviewed
Jan 10, 2025
docs/user/manual.adoc
Outdated
| /// 'testOne': This runnable will be used when the user clicks the 'Run Test' | ||
| /// CodeLens above a test. | ||
| /// | ||
| /// The args can contain two template strings: `{label}` and `{test_id}`. |
There was a problem hiding this comment.
This seems copy-pasted from above, by mistake.
Ensure that all the fields that rust-analyzer understands are in the manual, they all have doc comments, and they use consistent punctuation (`;` rather than mixing `,` and `;`). Whilst we're here, fix the `sysroot_src` example and add 2024 as a legal value for Rust edition.
Wilfred
force-pushed
the
document_build_info
branch
from
6ab6084 to
86a4b2f
Compare
lnicola
approved these changes
Jan 22, 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.
Ensure that all the fields that rust-analyzer understands are in the manual, they all have doc comments, and they use consistent punctuation (
;rather than mixing,and;).Whilst we're here, fix the
sysroot_srcexample and add 2024 as a legal value for Rust edition.