Skip to content

Commit ef0b3bb

Browse files
committed
Clarify documentation on new parameter
1 parent 53b6700 commit ef0b3bb

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

crates/rust-analyzer/src/config.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ config_data! {
484484
/// This is useful to prevent rust-analyzer's `cargo check` from blocking builds.
485485
///
486486
/// Set to `true` to use a subdirectory of the existing target directory or
487-
/// set to a path to use that path.
487+
/// set to a path relative to the workspace to use that path.
488488
rust_analyzerTargetDir: Option<TargetDirectory> = "null",
489489

490490
/// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private

docs/user/generated_config.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ Optional path to a rust-analyzer specific target directory.
764764
This is useful to prevent rust-analyzer's `cargo check` from blocking builds.
765765

766766
Set to `true` to use a subdirectory of the existing target directory or
767-
set to a path to use that path.
767+
set to a path relative to the workspace to use that path.
768768
--
769769
[[rust-analyzer.rustc.source]]rust-analyzer.rustc.source (default: `null`)::
770770
+

editors/code/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1489,7 +1489,7 @@
14891489
}
14901490
},
14911491
"rust-analyzer.rust.analyzerTargetDir": {
1492-
"markdownDescription": "Optional path to a rust-analyzer specific target directory.\nThis is useful to prevent rust-analyzer's `cargo check` from blocking builds.\n\nSet to `true` to use a subdirectory of the existing target directory or\nset to a path to use that path.",
1492+
"markdownDescription": "Optional path to a rust-analyzer specific target directory.\nThis is useful to prevent rust-analyzer's `cargo check` from blocking builds.\n\nSet to `true` to use a subdirectory of the existing target directory or\nset to a path relative to the workspace to use that path.",
14931493
"default": null,
14941494
"anyOf": [
14951495
{

0 commit comments

Comments
 (0)