Skip to content

Clean up descriptions for settings #6993

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

Merged
merged 1 commit into from
Dec 22, 2020
Merged

Clean up descriptions for settings #6993

Show file tree
Hide file tree
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
34 changes: 17 additions & 17 deletions crates/rust-analyzer/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ config_data! {
callInfo_full: bool = "true",

/// Automatically refresh project info via `cargo metadata` on
/// Cargo.toml changes.
/// `Cargo.toml` changes.
cargo_autoreload: bool = "true",
/// Activate all available features.
cargo_allFeatures: bool = "false",
Expand All @@ -52,7 +52,7 @@ config_data! {
/// Run specified `cargo check` command for diagnostics on save.
checkOnSave_enable: bool = "true",
/// Check with all features (will be passed as `--all-features`).
/// Defaults to `rust-analyzer.cargo.allFeatures`.
/// Defaults to `#rust-analyzer.cargo.allFeatures#`.
checkOnSave_allFeatures: Option<bool> = "null",
/// Check all targets and tests (will be passed as `--all-targets`).
checkOnSave_allTargets: bool = "true",
Expand All @@ -61,12 +61,12 @@ config_data! {
/// Do not activate the `default` feature.
checkOnSave_noDefaultFeatures: Option<bool> = "null",
/// Check for a specific target. Defaults to
/// `rust-analyzer.cargo.target`.
/// `#rust-analyzer.cargo.target#`.
checkOnSave_target: Option<String> = "null",
/// Extra arguments for `cargo check`.
checkOnSave_extraArgs: Vec<String> = "[]",
/// List of features to activate. Defaults to
/// `rust-analyzer.cargo.features`.
/// `#rust-analyzer.cargo.features#`.
checkOnSave_features: Option<Vec<String>> = "null",
/// Advanced option, fully override the command rust-analyzer uses for
/// checking. The command should include `--message-format=json` or
Expand All @@ -80,7 +80,7 @@ config_data! {
/// Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
completion_postfix_enable: bool = "true",
/// Toggles the additional completions that automatically add imports when completed.
/// Note that your client have to specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
/// Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
completion_autoimport_enable: bool = "true",

/// Whether to show native rust-analyzer diagnostics.
Expand All @@ -90,13 +90,13 @@ config_data! {
diagnostics_enableExperimental: bool = "true",
/// List of rust-analyzer diagnostics to disable.
diagnostics_disabled: FxHashSet<String> = "[]",
/// List of warnings that should be displayed with info severity.\nThe
/// List of warnings that should be displayed with info severity.\n\nThe
/// warnings will be indicated by a blue squiggly underline in code and
/// a blue icon in the problems panel.
/// a blue icon in the `Problems Panel`.
diagnostics_warningsAsHint: Vec<String> = "[]",
/// List of warnings that should be displayed with hint severity.\nThe
/// List of warnings that should be displayed with hint severity.\n\nThe
/// warnings will be indicated by faded text or three dots in code and
/// will not show up in the problems panel.
/// will not show up in the `Problems Panel`.
diagnostics_warningsAsInfo: Vec<String> = "[]",

/// Controls file watching implementation.
Expand All @@ -121,7 +121,7 @@ config_data! {

/// Whether to show inlay type hints for method chains.
inlayHints_chainingHints: bool = "true",
/// Maximum length for inlay hints.
/// Maximum length for inlay hints. Default is unlimited.
inlayHints_maxLength: Option<usize> = "null",
/// Whether to show function parameter name inlay hints at the call
/// site.
Expand All @@ -145,27 +145,27 @@ config_data! {
lens_methodReferences: bool = "false",

/// Disable project auto-discovery in favor of explicitly specified set
/// of projects. \nElements must be paths pointing to Cargo.toml,
/// rust-project.json, or JSON objects in rust-project.json format.
/// of projects.\n\nElements must be paths pointing to `Cargo.toml`,
/// `rust-project.json`, or JSON objects in `rust-project.json` format.
linkedProjects: Vec<ManifestOrProjectJson> = "[]",
/// Number of syntax trees rust-analyzer keeps in memory.
/// Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
lruCapacity: Option<usize> = "null",
/// Whether to show `can't find Cargo.toml` error message.
notifications_cargoTomlNotFound: bool = "true",
/// Enable Proc macro support, cargo.loadOutDirsFromCheck must be
/// Enable Proc macro support, `#rust-analyzer.cargo.loadOutDirsFromCheck#` must be
/// enabled.
procMacro_enable: bool = "false",

/// Command to be executed instead of 'cargo' for runnables.
runnables_overrideCargo: Option<String> = "null",
/// Additional arguments to be passed to cargo for runnables such as
/// tests or binaries.\nFor example, it may be '--release'.
/// tests or binaries.\nFor example, it may be `--release`.
runnables_cargoExtraArgs: Vec<String> = "[]",

/// Path to the rust compiler sources, for usage in rustc_private projects.
rustcSource : Option<String> = "null",

/// Additional arguments to rustfmt.
/// Additional arguments to `rustfmt`.
rustfmt_extraArgs: Vec<String> = "[]",
/// Advanced option, fully override the command rust-analyzer uses for
/// formatting.
Expand Down Expand Up @@ -758,7 +758,7 @@ fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json
],
"enumDescriptions": [
"Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item.",
"Prefix all import paths with `self` if they don't begin with `self`, `super`, `crate` or a crate name",
"Prefix all import paths with `self` if they don't begin with `self`, `super`, `crate` or a crate name.",
"Force import paths to be absolute by always starting them with `crate` or the crate name they refer to."
],
},
Expand Down
26 changes: 13 additions & 13 deletions docs/user/generated_config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ rust-analyzer.assist.importPrefix (default: `"plain"`)::
rust-analyzer.callInfo.full (default: `true`)::
Show function name and docs in parameter hints.
rust-analyzer.cargo.autoreload (default: `true`)::
Automatically refresh project info via `cargo metadata` on Cargo.toml changes.
Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes.
rust-analyzer.cargo.allFeatures (default: `false`)::
Activate all available features.
rust-analyzer.cargo.features (default: `[]`)::
Expand All @@ -21,19 +21,19 @@ rust-analyzer.cargo.noSysroot (default: `false`)::
rust-analyzer.checkOnSave.enable (default: `true`)::
Run specified `cargo check` command for diagnostics on save.
rust-analyzer.checkOnSave.allFeatures (default: `null`)::
Check with all features (will be passed as `--all-features`). Defaults to `rust-analyzer.cargo.allFeatures`.
Check with all features (will be passed as `--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`.
rust-analyzer.checkOnSave.allTargets (default: `true`)::
Check all targets and tests (will be passed as `--all-targets`).
rust-analyzer.checkOnSave.command (default: `"check"`)::
Cargo command to use for `cargo check`.
rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
Do not activate the `default` feature.
rust-analyzer.checkOnSave.target (default: `null`)::
Check for a specific target. Defaults to `rust-analyzer.cargo.target`.
Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`.
rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
Extra arguments for `cargo check`.
rust-analyzer.checkOnSave.features (default: `null`)::
List of features to activate. Defaults to `rust-analyzer.cargo.features`.
List of features to activate. Defaults to `#rust-analyzer.cargo.features#`.
rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option.
rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
Expand All @@ -43,17 +43,17 @@ rust-analyzer.completion.addCallParenthesis (default: `true`)::
rust-analyzer.completion.postfix.enable (default: `true`)::
Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
rust-analyzer.completion.autoimport.enable (default: `true`)::
Toggles the additional completions that automatically add imports when completed. Note that your client have to specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
Toggles the additional completions that automatically add imports when completed. Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
rust-analyzer.diagnostics.enable (default: `true`)::
Whether to show native rust-analyzer diagnostics.
rust-analyzer.diagnostics.enableExperimental (default: `true`)::
Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.
rust-analyzer.diagnostics.disabled (default: `[]`)::
List of rust-analyzer diagnostics to disable.
rust-analyzer.diagnostics.warningsAsHint (default: `[]`)::
List of warnings that should be displayed with info severity.\nThe warnings will be indicated by a blue squiggly underline in code and a blue icon in the problems panel.
List of warnings that should be displayed with info severity.\n\nThe warnings will be indicated by a blue squiggly underline in code and a blue icon in the `Problems Panel`.
rust-analyzer.diagnostics.warningsAsInfo (default: `[]`)::
List of warnings that should be displayed with hint severity.\nThe warnings will be indicated by faded text or three dots in code and will not show up in the problems panel.
List of warnings that should be displayed with hint severity.\n\nThe warnings will be indicated by faded text or three dots in code and will not show up in the `Problems Panel`.
rust-analyzer.files.watcher (default: `"client"`)::
Controls file watching implementation.
rust-analyzer.hoverActions.debug (default: `true`)::
Expand All @@ -71,7 +71,7 @@ rust-analyzer.hoverActions.linksInHover (default: `true`)::
rust-analyzer.inlayHints.chainingHints (default: `true`)::
Whether to show inlay type hints for method chains.
rust-analyzer.inlayHints.maxLength (default: `null`)::
Maximum length for inlay hints.
Maximum length for inlay hints. Default is unlimited.
rust-analyzer.inlayHints.parameterHints (default: `true`)::
Whether to show function parameter name inlay hints at the call site.
rust-analyzer.inlayHints.typeHints (default: `true`)::
Expand All @@ -87,20 +87,20 @@ rust-analyzer.lens.run (default: `true`)::
rust-analyzer.lens.methodReferences (default: `false`)::
Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
rust-analyzer.linkedProjects (default: `[]`)::
Disable project auto-discovery in favor of explicitly specified set of projects. \nElements must be paths pointing to Cargo.toml, rust-project.json, or JSON objects in rust-project.json format.
Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format.
rust-analyzer.lruCapacity (default: `null`)::
Number of syntax trees rust-analyzer keeps in memory.
Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
Whether to show `can't find Cargo.toml` error message.
rust-analyzer.procMacro.enable (default: `false`)::
Enable Proc macro support, cargo.loadOutDirsFromCheck must be enabled.
Enable Proc macro support, `#rust-analyzer.cargo.loadOutDirsFromCheck#` must be enabled.
rust-analyzer.runnables.overrideCargo (default: `null`)::
Command to be executed instead of 'cargo' for runnables.
rust-analyzer.runnables.cargoExtraArgs (default: `[]`)::
Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be '--release'.
Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`.
rust-analyzer.rustcSource (default: `null`)::
Path to the rust compiler sources, for usage in rustc_private projects.
rust-analyzer.rustfmt.extraArgs (default: `[]`)::
Additional arguments to rustfmt.
Additional arguments to `rustfmt`.
rust-analyzer.rustfmt.overrideCommand (default: `null`)::
Advanced option, fully override the command rust-analyzer uses for formatting.
Loading