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

gopls/doc: fix inconsistent rendering of enum newlines 

We have inconsistent rendering of newlines in enums, as pointed out in
CL 314189 (that change edited the markdown directly, which won't work).

Change-Id: Ie39b80fe65287bd447d18cacdaea60b24b4bd08f
Reviewed-on: https://go-review.googlesource.com/c/tools/+/369957
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Peter Weinberger <pjw@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
This commit is contained in:
Robert Findley 2021-12-07 17:49:52 -05:00
parent 523d859406
commit a71de3f351
2 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
gopls/doc/settings.md
View File

@ -94,8 +94,8 @@ Must be one of:
* `"DegradeClosed"`: In DegradeClosed mode, `gopls` will collect less information about
packages without open files. As a result, features like Find
References and Rename will miss results in such packages.
* `"Normal"`
Default: `"Normal"`.
#### **expandWorkspaceToModule** *bool*
@ -247,6 +247,7 @@ Must be one of:
* `"CaseInsensitive"`
* `"CaseSensitive"`
* `"Fuzzy"`
Default: `"Fuzzy"`.
##### **experimentalPostfixCompletions** *bool*
@ -298,11 +299,8 @@ that should be reported by the gc_details command.
Can contain any of:
* `"bounds"` controls bounds checking diagnostics.
* `"escape"` controls diagnostics about escape choices.
* `"inline"` controls diagnostics about inlining choices.
* `"nil"` controls nil checks.
Default: `{"bounds":true,"escape":true,"inline":true,"nil":true}`.
@ -350,8 +348,8 @@ Must be one of:
This format separates the signature from the documentation, so that the client
can do more manipulation of these fields.\
This should only be used by clients that support this behavior.
* `"SynopsisDocumentation"`
Default: `"FullDocumentation"`.
##### **linkTarget** *string*
@ -384,6 +382,7 @@ Must be one of:
* `"Both"`
* `"Definition"`
* `"Link"`
Default: `"Both"`.
##### **symbolMatcher** *enum*
@ -398,6 +397,7 @@ Must be one of:
* `"CaseSensitive"`
* `"FastFuzzy"`
* `"Fuzzy"`
Default: `"Fuzzy"`.
##### **symbolStyle** *enum*
@ -422,10 +422,8 @@ Must be one of:
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".
* `"Full"` is fully qualified symbols, i.e.
"path/to/pkg.Foo.Field".
* `"Package"` is package qualified symbols i.e.
"pkg.Foo.Field".

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

@ -1336,12 +1336,9 @@ func collectEnums(opt *OptionJSON) string {
write := func(name, doc string, index, len int) {
if doc != "" {
unbroken := parBreakRE.ReplaceAllString(doc, "\\\n")
fmt.Fprintf(&b, "* %s", unbroken)
fmt.Fprintf(&b, "* %s\n", strings.TrimSpace(unbroken))
} else {
fmt.Fprintf(&b, "* `%s`", name)
}
if index < len-1 {
fmt.Fprint(&b, "\n")
fmt.Fprintf(&b, "* `%s`\n", name)
}
}
if len(opt.EnumValues) > 0 && opt.Type == "enum" {