Add better documentation for excluding imports from symbol search

This commit is contained in:
Lucas Holten 2025-06-20 13:20:59 +02:00
parent b0552d779f
commit 7492b63c18
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"
}