Skip to content

Commit c00c94d

Browse files
adonovangopherbot
authored andcommitted
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 <[email protected]> Auto-Submit: Alan Donovan <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]>
1 parent ef0f4a4 commit c00c94d

File tree

3 files changed

+8
-11
lines changed

3 files changed

+8
-11
lines changed

gopls/doc/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ So, before sending a CL, please please please:
1010
exist already. This allows us to identify redundant requests, or to
1111
merge a specific problem into a more general one, and to assess the
1212
importance of the problem.
13-
1413
- **claim it for yourself** by commenting on the issue or, if you are
1514
able, by assigning the issue to yourself. This helps us avoid two
1615
people working on the same problem.
17-
1816
- **propose an implementation plan** in the issue tracker for CLs of
1917
any complexity. It is much more efficient to discuss the plan at a
2018
high level before we start getting bogged down in the details of
@@ -41,7 +39,7 @@ for example by making the code self-explanatory.
4139
It's fine to disagree with a comment,
4240
point out a reviewer's mistake,
4341
or offer to address a comment in a follow-up change,
44-
leaving a TODO comment in the current CL.
42+
leaving a `TODO` comment in the current CL.
4543
But please don't dismiss or quietly ignore a comment without action,
4644
as it may lead reviewers to repeat themselves,
4745
or to serious problems being neglected.
@@ -60,8 +58,10 @@ claiming it.
6058

6159
## Getting started
6260

63-
Most of the `gopls` logic is in the `golang.org/x/tools/gopls/internal`
64-
directory. See [design/implementation.md](./design/implementation.md) for an overview of the code organization.
61+
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools/gopls/internal)](https://pkg.go.dev/golang.org/x/tools/gopls/internal)
62+
63+
Most of the `gopls` logic is in the `golang.org/x/tools/gopls/internal` directory.
64+
See [design/implementation.md](./design/implementation.md) for an overview of the code organization.
6565

6666
## Build
6767

gopls/doc/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ title: "Gopls: The language server for Go"
99
$ open http://localhost:6060/go.dev/gopls
1010
-->
1111

12-
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools/gopls)](https://pkg.go.dev/golang.org/x/tools/gopls)
13-
1412
`gopls` (pronounced "Go please") is the official [language
1513
server](https://langserver.org) for Go, developed by the Go team. It
1614
provides a wide variety of [IDE features](features/) to any
@@ -32,7 +30,7 @@ To preview documentation for the release under development, visit https://tip.go
3230
## Features
3331

3432
Gopls supports a wide range of standard LSP features for navigation,
35-
completion, diagnostics, analysis, and refactoring, and number of
33+
completion, diagnostics, analysis, and refactoring, and a number of
3634
additional features not found in other language servers.
3735

3836
See the [Index of features](features/) for complete

gopls/main.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
// to be extended with IDE-like features;
88
// see https://langserver.org/ for details.
99
//
10-
// See https://github.com/golang/tools/blob/master/gopls/doc/index.md
11-
// for the most up-to-date documentation.
12-
package main // import "golang.org/x/tools/gopls"
10+
// See https://go.dev/gopls for comprehensive documentation on Gopls.
11+
package main
1312

1413
import (
1514
"context"

0 commit comments

Comments
 (0)