mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

internal/lsp/source: improve documentation for symbolStyle 

Now that we have documentation generation, improve the docstring for the
symbolStyle option.

Change-Id: I3c6de430eea501ecf797a11873c53c565cae9075
Reviewed-on: https://go-review.googlesource.com/c/tools/+/258617
Run-TryBot: Robert Findley <rfindley@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
Trust: Robert Findley <rfindley@google.com>
This commit is contained in:
Rob Findley 2020-09-30 23:20:05 -04:00 committed by Robert Findley
parent 08f19738fa
commit 7e5cd54378
3 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
gopls/doc/settings.md
View File

@ -182,7 +182,23 @@ Must be one of:
Default: `"Fuzzy"`.
### **symbolStyle** *enum*
symbolStyle specifies what style of symbols to return in symbol requests.
symbolStyle controls how symbols are qualified in symbol responses. It
accepts the following values:
* "full": symbols are fully qualified, i.e. "path/to/pkg.Foo.Field"
* "package": symbols are package qualified, i.e. "pkg.Foo.Field"
* "dynamic": symbols are qualified using whichever qualifier results in
the highest scoring match for the given symbol query. Here a
"qualifier" is any "/" or "." delimited suffix of the fully qualified
symbol. i.e. "to/pkg.Foo.Field" or just "Foo.Field".
Example Usage:
```json5
"gopls": {
...
"symbolStyle": "dynamic",
...
}
```
Must be one of:
* `"Dynamic"`

2
internal/lsp/source/api_json.go
View File

File diff suppressed because one or more lines are too long

18
internal/lsp/source/options.go
View File

@ -296,7 +296,23 @@ type ExperimentalOptions struct {
// SymbolMatcher sets the algorithm that is used when finding workspace symbols.
SymbolMatcher SymbolMatcher
// SymbolStyle specifies what style of symbols to return in symbol requests.
// SymbolStyle controls how symbols are qualified in symbol responses. It
// accepts the following values:
// * "full": symbols are fully qualified, i.e. "path/to/pkg.Foo.Field"
// * "package": symbols are package qualified, i.e. "pkg.Foo.Field"
// * "dynamic": symbols are qualified using whichever qualifier results in
// the highest scoring match for the given symbol query. Here a
// "qualifier" is any "/" or "." delimited suffix of the fully qualified
// symbol. i.e. "to/pkg.Foo.Field" or just "Foo.Field".
//
// Example Usage:
// ```json5
// "gopls": {
// ...
// "symbolStyle": "dynamic",
// ...
// }
// ```
SymbolStyle SymbolStyle
// LinksInHover toggles the presence of links to documentation in hover.