diff options
author | Russ Cox <rsc@golang.org> | 2022-01-29 19:07:27 -0500 |
---|---|---|
committer | Russ Cox <rsc@golang.org> | 2022-04-01 18:18:01 +0000 |
commit | 7d87ccc860dc31c0cd60faf00720e2f30fd37efb (patch) | |
tree | 3dc01e7fa04a4683de0583774fab0e881bae7193 /src/cmd/go/script_test.go | |
parent | df89f2ba53aab53356be197c581d142cefc2c6bc (diff) | |
download | go-7d87ccc860dc31c0cd60faf00720e2f30fd37efb.tar.gz go-7d87ccc860dc31c0cd60faf00720e2f30fd37efb.zip |
all: fix various doc comment formatting nits
A run of lines that are indented with any number of spaces or tabs
format as a <pre> block. This commit fixes various doc comments
that format badly according to that (standard) rule.
For example, consider:
// - List item.
// Second line.
// - Another item.
Because the - lines are unindented, this is actually two paragraphs
separated by a one-line <pre> block. This CL rewrites it to:
// - List item.
// Second line.
// - Another item.
Today, that will format as a single <pre> block.
In a future release, we hope to format it as a bulleted list.
Various other minor fixes as well, all in preparation for reformatting.
For #51082.
Change-Id: I95cf06040d4186830e571cd50148be3bf8daf189
Reviewed-on: https://go-review.googlesource.com/c/go/+/384257
Trust: Russ Cox <rsc@golang.org>
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Diffstat (limited to 'src/cmd/go/script_test.go')
-rw-r--r-- | src/cmd/go/script_test.go | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/cmd/go/script_test.go b/src/cmd/go/script_test.go index bffbe32220..76a2b85f96 100644 --- a/src/cmd/go/script_test.go +++ b/src/cmd/go/script_test.go @@ -1373,7 +1373,9 @@ type command struct { // parse parses a single line as a list of space-separated arguments // subject to environment variable expansion (but not resplitting). // Single quotes around text disable splitting and expansion. -// To embed a single quote, double it: 'Don''t communicate by sharing memory.' +// To embed a single quote, double it: +// +// 'Don''t communicate by sharing memory.' func (ts *testScript) parse(line string) command { ts.line = line |