Auto merge of #16988 - Veykril:config-docs, r=Veykril

fix: Fix `allFeatures` config docs
rust-lang · Apr 1, 2024 · ff8a24a · ff8a24a
2 parents c82d168 + ff279f1
commit ff8a24a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs
@@ -71,8 +71,7 @@ config_data! {
         /// How many worker threads to handle priming caches. The default `0` means to pick automatically.
         cachePriming_numThreads: ParallelCachePrimingNumThreads = "0",
 
-        /// Pass `--all-targets` to cargo invocation. Overridden by `#rust-analyzer.check.allTargets#`
-        /// when the latter is set.
+        /// Pass `--all-targets` to cargo invocation.
         cargo_allTargets: bool           = "true",
         /// Automatically refresh project info via `cargo metadata` on
         /// `Cargo.toml` or `.cargo/config.toml` changes.
@@ -166,7 +165,8 @@ config_data! {
         /// Run the check command for diagnostics on save.
         checkOnSave | checkOnSave_enable: bool                         = "true",
 
-        /// Check all targets and tests (`--all-targets`). Overrides `#rust-analyzer.cargo.allTargets#`.
+        /// Check all targets and tests (`--all-targets`). Defaults to
+        /// `#rust-analyzer.cargo.allTargets#`.
         check_allTargets | checkOnSave_allTargets: Option<bool>          = "null",
         /// Cargo command to use for `cargo check`.
         check_command | checkOnSave_command: String                      = "\"check\"",

diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
@@ -22,8 +22,7 @@ How many worker threads to handle priming caches. The default `0` means to pick
 [[rust-analyzer.cargo.allTargets]]rust-analyzer.cargo.allTargets (default: `true`)::
 +
 --
-Pass `--all-targets` to cargo invocation. Overridden by `#rust-analyzer.check.allTargets#`
-when the latter is set.
+Pass `--all-targets` to cargo invocation.
 --
 [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
 +
@@ -173,7 +172,8 @@ Run the check command for diagnostics on save.
 [[rust-analyzer.check.allTargets]]rust-analyzer.check.allTargets (default: `null`)::
 +
 --
-Check all targets and tests (`--all-targets`). Overrides `#rust-analyzer.cargo.allTargets#`.
+Check all targets and tests (`--all-targets`). Defaults to
+`#rust-analyzer.cargo.allTargets#`.
 --
 [[rust-analyzer.check.command]]rust-analyzer.check.command (default: `"check"`)::
 +

diff --git a/editors/code/package.json b/editors/code/package.json
@@ -547,7 +547,7 @@
                     "maximum": 255
                 },
                 "rust-analyzer.cargo.allTargets": {
-                    "markdownDescription": "Pass `--all-targets` to cargo invocation. Overridden by `#rust-analyzer.check.allTargets#`\nwhen the latter is set.",
+                    "markdownDescription": "Pass `--all-targets` to cargo invocation.",
                     "default": true,
                     "type": "boolean"
                 },
@@ -712,7 +712,7 @@
                     "type": "boolean"
                 },
                 "rust-analyzer.check.allTargets": {
-                    "markdownDescription": "Check all targets and tests (`--all-targets`). Overrides `#rust-analyzer.cargo.allTargets#`.",
+                    "markdownDescription": "Check all targets and tests (`--all-targets`). Defaults to\n`#rust-analyzer.cargo.allTargets#`.",
                     "default": null,
                     "type": [
                         "null",