File tree Expand file tree Collapse file tree 1 file changed +20
-2
lines changed Expand file tree Collapse file tree 1 file changed +20
-2
lines changed Original file line number Diff line number Diff line change @@ -16,13 +16,31 @@ read the documentation for locally edited packages, even ones that
16
16
have not yet been saved. Reload the page after an edit to see updated
17
17
documentation.
18
18
19
- TODO: demo of VS Code ` Source action > View package documentation ` .
19
+ TODO: demo in VS Code.
20
20
21
21
Clicking on the source-code link associated with a declaration will
22
22
cause your editor to navigate to the declaration.
23
23
24
24
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.
26
44
27
45
### ` unusedwrite ` analyzer
28
46
You can’t perform that action at this time.
0 commit comments