Skip to content

Commit 7204363

Browse files
adonovangopherbot
authored andcommitted
gopls/doc/release/v0.16.0.md: augment notes for "view pkg doc"
Change-Id: Ieaef6c74b7fe1f7d736c1fb23c13c7569193ff3a Reviewed-on: https://go-review.googlesource.com/c/tools/+/575376 Reviewed-by: Robert Findley <[email protected]> Auto-Submit: Alan Donovan <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]>
1 parent 904c6ba commit 7204363

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

gopls/doc/release/v0.16.0.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,31 @@ read the documentation for locally edited packages, even ones that
1616
have not yet been saved. Reload the page after an edit to see updated
1717
documentation.
1818

19-
TODO: demo of VS Code `Source action > View package documentation`.
19+
TODO: demo in VS Code.
2020

2121
Clicking on the source-code link associated with a declaration will
2222
cause your editor to navigate to the declaration.
2323

2424
TODO: demo of source linking.
25-
TODO: appeal to VS Code users to upvote https://github.com/microsoft/vscode/issues/208093?
25+
26+
Editor support:
27+
28+
- VS Code: use the `Source action > View package documentation` menu item.
29+
Note: source links navigate the editor but don't yet raise the window yet.
30+
Please upvote https://github.com/microsoft/vscode/issues/208093 and
31+
https://github.com/microsoft/vscode/issues/207634 (temporarily closed).
32+
33+
- Emacs: requires eglot v1.17. You may find this `go-doc` function a
34+
useful shortcut:
35+
36+
```lisp
37+
(eglot--code-action eglot-code-action-doc "source.doc")
38+
39+
(defalias 'go-doc #'eglot-code-action-doc
40+
"View documentation for the current Go package.")
41+
```
42+
43+
- TODO: test in vim, neovim, sublime, helix.
2644

2745
### `unusedwrite` analyzer
2846

0 commit comments

Comments
 (0)