Merge pull request #20050 from LHolten/better-docs-for-exclude-imports-in-symbol-search
Some checks are pending
metrics / other_metrics (diesel-1.4.8) (push) Blocked by required conditions
metrics / build_metrics (push) Waiting to run
metrics / other_metrics (hyper-0.14.18) (push) Blocked by required conditions
metrics / other_metrics (ripgrep-13.0.0) (push) Blocked by required conditions
metrics / other_metrics (self) (push) Blocked by required conditions
metrics / other_metrics (webrender-2022) (push) Blocked by required conditions
metrics / generate_final_metrics (push) Blocked by required conditions
rustdoc / rustdoc (push) Waiting to run

Add better documentation for excluding imports from symbol search
This commit is contained in:
Chayim Refael Friedman 2025-06-21 20:34:56 +00:00 committed by GitHub
commit 0ddaf2cd7b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 11 additions and 3 deletions

View file

@ -762,7 +762,11 @@ config_data! {
/// though Cargo might be the eventual consumer.
vfs_extraIncludes: Vec<String> = vec![],
/// Exclude imports from symbol search.
/// Exclude all imports from workspace symbol search.
///
/// In addition to regular imports (which are always excluded),
/// this option removes public imports (better known as re-exports)
/// and removes imports that rename the imported symbol.
workspace_symbol_search_excludeImports: bool = false,
/// Workspace symbol search kind.
workspace_symbol_search_kind: WorkspaceSymbolSearchKindDef = WorkspaceSymbolSearchKindDef::OnlyTypes,

View file

@ -1542,7 +1542,11 @@ https://github.com/facebook/buck2/tree/main/integrations/rust-project.
Default: `false`
Exclude imports from symbol search.
Exclude all imports from workspace symbol search.
In addition to regular imports (which are always excluded),
this option removes public imports (better known as re-exports)
and removes imports that rename the imported symbol.
## rust-analyzer.workspace.symbol.search.kind {#workspace.symbol.search.kind}

View file

@ -2905,7 +2905,7 @@
"title": "workspace",
"properties": {
"rust-analyzer.workspace.symbol.search.excludeImports": {
"markdownDescription": "Exclude imports from symbol search.",
"markdownDescription": "Exclude all imports from workspace symbol search.\n\nIn addition to regular imports (which are always excluded),\nthis option removes public imports (better known as re-exports)\nand removes imports that rename the imported symbol.",
"default": false,
"type": "boolean"
}