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 <hyangah@gmail.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Robert Findley <rfindley@google.com>
diff --git a/gopls/doc/settings.md b/gopls/doc/settings.md
index 9f692cf..9aba219 100644
--- a/gopls/doc/settings.md
+++ b/gopls/doc/settings.md
@@ -489,10 +489,9 @@
##### **symbolScope** *enum*
symbolScope controls which packages are searched for workspace/symbol
-requests. The default value, "workspace", searches only workspace
-packages. The legacy behavior, "all", causes all loaded packages to be
-searched, including dependencies; this is more expensive and may return
-unwanted results.
+requests. When the scope is "workspace", gopls searches only workspace
+packages. When the scope is "all", gopls searches all loaded packages,
+including dependencies and the standard library.
Must be one of:
diff --git a/gopls/internal/settings/api_json.go b/gopls/internal/settings/api_json.go
index a29a417..8898a1f 100644
--- a/gopls/internal/settings/api_json.go
+++ b/gopls/internal/settings/api_json.go
@@ -197,7 +197,7 @@
{
Name: "symbolScope",
Type: "enum",
- Doc: "symbolScope controls which packages are searched for workspace/symbol\nrequests. The default value, \"workspace\", searches only workspace\npackages. The legacy behavior, \"all\", causes all loaded packages to be\nsearched, including dependencies; this is more expensive and may return\nunwanted results.\n",
+ Doc: "symbolScope controls which packages are searched for workspace/symbol\nrequests. When the scope is \"workspace\", gopls searches only workspace\npackages. When the scope is \"all\", gopls searches all loaded packages,\nincluding dependencies and the standard library.\n",
EnumValues: []EnumValue{
{
Value: "\"all\"",
diff --git a/gopls/internal/settings/settings.go b/gopls/internal/settings/settings.go
index df3e560..8b38497 100644
--- a/gopls/internal/settings/settings.go
+++ b/gopls/internal/settings/settings.go
@@ -339,10 +339,9 @@
SymbolStyle SymbolStyle `status:"advanced"`
// SymbolScope controls which packages are searched for workspace/symbol
- // requests. The default value, "workspace", searches only workspace
- // packages. The legacy behavior, "all", causes all loaded packages to be
- // searched, including dependencies; this is more expensive and may return
- // unwanted results.
+ // requests. When the scope is "workspace", gopls searches only workspace
+ // packages. When the scope is "all", gopls searches all loaded packages,
+ // including dependencies and the standard library.
SymbolScope SymbolScope
}
