]> Cypherpunks repositories - gostls13.git/commitdiff
cmd/go: update "go help doc" docs
authorRoi Martin <jroi.martin@gmail.com>
Tue, 30 Nov 2021 18:35:47 +0000 (19:35 +0100)
committerBryan Mills <bcmills@google.com>
Mon, 6 Dec 2021 19:10:14 +0000 (19:10 +0000)
This CL updates "go help doc" docs so they reflect the following
changes:

- CL 59413 modified "go doc", so the behavior of the two-args case is
  consistent with the one-arg one.
- CL 141397 removed godoc's command-line interface in favor of "go doc".

Fixes #49830.

Change-Id: I0923634291d34ae663fe2944d69757462b814919
Reviewed-on: https://go-review.googlesource.com/c/go/+/367497
Reviewed-by: Bryan Mills <bcmills@google.com>
Run-TryBot: Bryan Mills <bcmills@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Trust: Russ Cox <rsc@golang.org>

src/cmd/go/alldocs.go
src/cmd/go/internal/doc/doc.go

index 12b64d309c359f58d261bd354e0e908d6d5cad34..b9fca791be6ed4f1eb97a00b14eb0b978fcc1af2 100644 (file)
 // path. The go tool's usual package mechanism does not apply: package path
 // elements like . and ... are not implemented by go doc.
 //
-// When run with two arguments, the first must be a full package path (not just a
-// suffix), and the second is a symbol, or symbol with method or struct field.
-// This is similar to the syntax accepted by godoc:
+// When run with two arguments, the first is a package path (full path or suffix),
+// and the second is a symbol, or symbol with method or struct field:
 //
 //     go doc <pkg> <sym>[.<methodOrField>]
 //
index 8580a5dc4d2482a7e2f88640abe9a76a245adb18..7741a9022c910a0bee6c4084e55503bc6aea9c09 100644 (file)
@@ -60,9 +60,8 @@ The package path must be either a qualified path or a proper suffix of a
 path. The go tool's usual package mechanism does not apply: package path
 elements like . and ... are not implemented by go doc.
 
-When run with two arguments, the first must be a full package path (not just a
-suffix), and the second is a symbol, or symbol with method or struct field.
-This is similar to the syntax accepted by godoc:
+When run with two arguments, the first is a package path (full path or suffix),
+and the second is a symbol, or symbol with method or struct field:
 
        go doc <pkg> <sym>[.<methodOrField>]