Skip to content

Commit 4724ef9

Browse files
adonovangopherbot
authored andcommitted
gopls/doc: more doc tweaks
For golang/go#68977 Change-Id: I1439b62c47bfc193a54c02584fe11594163f3f70 Reviewed-on: https://go-review.googlesource.com/c/tools/+/686836 LUCI-TryBot-Result: Go LUCI <[email protected]> Auto-Submit: Alan Donovan <[email protected]> Reviewed-by: Robert Findley <[email protected]>
1 parent fa09424 commit 4724ef9

File tree

6 files changed

+20
-6
lines changed

6 files changed

+20
-6
lines changed

gopls/doc/features/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ when making significant changes to existing features or when adding new ones.
6868
You can find this page from within your editor by executing the
6969
`gopls.doc.features` [code action](transformation.md#code-actions),
7070
which opens it in a web browser.
71-
In VS Code, you can find it on the Quick fix menu.
71+
In VS Code, you can find it on the "Quick fix" menu.

gopls/doc/features/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ for the references to a symbol defined in `foo_windows.go`, the result
7373
will never include the file `bar_linux.go`, even if that file refers
7474
to a symbol of the same name; see https://go.dev/issue/65755.
7575

76-
Clients can request that the the declaration be included among the
76+
Clients can request that the declaration be included among the
7777
references; most do.
7878

7979
Client support:

gopls/doc/features/web.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,12 +170,12 @@ could (in principle) be split into three subpackages, one for
170170
formatting (`Printf` and friends), one for scanning (`Scanf`), and one
171171
for their common dependencies.
172172

173-
<img title="Split package 'fmt'" src="../assets/splitpkg.png">
173+
<img title="Split package 'fmt'" src="../assets/splitpkg.png" width="55%">
174174

175175
(Try playing with the tool on this package: it's an instructive
176176
exercise. The figure below shows the solution.)
177177

178-
<img title="Split package 'fmt'" src="../assets/splitpkg-deps.png">
178+
<img title="Split package 'fmt'" src="../assets/splitpkg-deps.png" width="55%">
179179

180180
The tool does not currently perform the code transformation (moving
181181
declarations to new packages, renaming symbols to export them as

gopls/doc/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
22
title: "Gopls: The language server for Go"
33
---
4-
<!-- This is the main landing page for gopls users. -->
4+
<!--
5+
This is the main landing page for gopls users.
6+
7+
To preview locally edited markdown files, use:
8+
$ GOLANGORG_LOCAL_X_TOOLS=$(pwd) go run golang.org/x/website/cmd/golangorg@master &
9+
$ open http://localhost:6060/go.dev/gopls
10+
-->
511

612
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools/gopls)](https://pkg.go.dev/golang.org/x/tools/gopls)
713

gopls/doc/release/v0.16.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Editor support:
102102
- Emacs: requires eglot v1.17. Use `M-x go-browse-doc` from github.com/dominikh/go-mode.el.
103103

104104
The `linksInHover` setting now supports a new value, `"gopls"`,
105-
that causes documentation links in the the Markdown output
105+
that causes documentation links in the Markdown output
106106
of the Hover operation to link to gopls' internal doc viewer.
107107

108108
### Browse free symbols

gopls/doc/release/v0.20.0.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
title: "Gopls release v0.20.0 (forthcoming)"
33
---
44

5+
Gopls' documentation is now available on the Go project's website at
6+
https://go.dev/gopls. (Note: this link will not be accurate until the
7+
completion of the release. Dueing the pre-release period, please use
8+
https://tip.golang.org/gopls, which reflects the latest commit.)
9+
10+
Unlike markdown files in GitHub, these pages are crawled by Google's
11+
web search index.
12+
513
## Configuration Changes
614

715
## Navigation features

0 commit comments

Comments
 (0)