Skip to content

Commit 5e04895

Browse files
findleyrgopherbot
authored andcommitted
gopls/internal/settings: update stale documentation for "symbolScope"
The docstring for the "symbolScope" setting is a relic from when we attempted to make "workspace" the default value, but the default was subsequently reverted to "all". Update the docstring to not assume a default. Change-Id: Ib97b9e7f40227067dedb87700ea7c19bb2758660 Reviewed-on: https://go-review.googlesource.com/c/tools/+/578935 Reviewed-by: Hyang-Ah Hana Kim <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]> Auto-Submit: Robert Findley <[email protected]>
1 parent 0c3722a commit 5e04895

File tree

3 files changed

+7
-9
lines changed

3 files changed

+7
-9
lines changed

gopls/doc/settings.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -489,10 +489,9 @@ Default: `"Dynamic"`.
489489
##### **symbolScope** *enum*
490490

491491
symbolScope controls which packages are searched for workspace/symbol
492-
requests. The default value, "workspace", searches only workspace
493-
packages. The legacy behavior, "all", causes all loaded packages to be
494-
searched, including dependencies; this is more expensive and may return
495-
unwanted results.
492+
requests. When the scope is "workspace", gopls searches only workspace
493+
packages. When the scope is "all", gopls searches all loaded packages,
494+
including dependencies and the standard library.
496495

497496
Must be one of:
498497

gopls/internal/settings/api_json.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gopls/internal/settings/settings.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -339,10 +339,9 @@ type NavigationOptions struct {
339339
SymbolStyle SymbolStyle `status:"advanced"`
340340

341341
// SymbolScope controls which packages are searched for workspace/symbol
342-
// requests. The default value, "workspace", searches only workspace
343-
// packages. The legacy behavior, "all", causes all loaded packages to be
344-
// searched, including dependencies; this is more expensive and may return
345-
// unwanted results.
342+
// requests. When the scope is "workspace", gopls searches only workspace
343+
// packages. When the scope is "all", gopls searches all loaded packages,
344+
// including dependencies and the standard library.
346345
SymbolScope SymbolScope
347346
}
348347

0 commit comments

Comments
 (0)