gopls/doc: yet more tweaks - move pkg.go.dev link into Contributing - update links - fix typos Change-Id: I2ecdcdb5d692ceb3afeb48a18f7e0e7fd8f64e6d Reviewed-on: https://go-review.googlesource.com/c/tools/+/691895 Reviewed-by: Robert Findley <rfindley@google.com> Auto-Submit: Alan Donovan <adonovan@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
diff --git a/gopls/doc/contributing.md b/gopls/doc/contributing.md index 38644fc..47161ac 100644 --- a/gopls/doc/contributing.md +++ b/gopls/doc/contributing.md
@@ -10,11 +10,9 @@ exist already. This allows us to identify redundant requests, or to merge a specific problem into a more general one, and to assess the importance of the problem. - - **claim it for yourself** by commenting on the issue or, if you are able, by assigning the issue to yourself. This helps us avoid two people working on the same problem. - - **propose an implementation plan** in the issue tracker for CLs of any complexity. It is much more efficient to discuss the plan at a high level before we start getting bogged down in the details of @@ -41,7 +39,7 @@ It's fine to disagree with a comment, point out a reviewer's mistake, or offer to address a comment in a follow-up change, -leaving a TODO comment in the current CL. +leaving a `TODO` comment in the current CL. But please don't dismiss or quietly ignore a comment without action, as it may lead reviewers to repeat themselves, or to serious problems being neglected. @@ -60,8 +58,10 @@ ## Getting started -Most of the `gopls` logic is in the `golang.org/x/tools/gopls/internal` -directory. See [design/implementation.md](./design/implementation.md) for an overview of the code organization. +[](https://pkg.go.dev/golang.org/x/tools/gopls/internal) + +Most of the `gopls` logic is in the `golang.org/x/tools/gopls/internal` directory. +See [design/implementation.md](./design/implementation.md) for an overview of the code organization. ## Build
diff --git a/gopls/doc/index.md b/gopls/doc/index.md index 7557d95..0e6f1c8 100644 --- a/gopls/doc/index.md +++ b/gopls/doc/index.md
@@ -9,8 +9,6 @@ $ open http://localhost:6060/go.dev/gopls --> -[](https://pkg.go.dev/golang.org/x/tools/gopls) - `gopls` (pronounced "Go please") is the official [language server](https://langserver.org) for Go, developed by the Go team. It provides a wide variety of [IDE features](features/) to any @@ -32,7 +30,7 @@ ## Features Gopls supports a wide range of standard LSP features for navigation, -completion, diagnostics, analysis, and refactoring, and number of +completion, diagnostics, analysis, and refactoring, and a number of additional features not found in other language servers. See the [Index of features](features/) for complete
diff --git a/gopls/main.go b/gopls/main.go index 4ef58df..b439f35 100644 --- a/gopls/main.go +++ b/gopls/main.go
@@ -7,9 +7,8 @@ // to be extended with IDE-like features; // see https://langserver.org/ for details. // -// See https://github.com/golang/tools/blob/master/gopls/doc/index.md -// for the most up-to-date documentation. -package main // import "golang.org/x/tools/gopls" +// See https://go.dev/gopls for comprehensive documentation on Gopls. +package main import ( "context"