aboutsummaryrefslogtreecommitdiff
path: root/src/cmd/doc
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2015-08-31 13:56:23 -0700
committerRob Pike <r@golang.org>2015-09-02 17:58:17 +0000
commit45537d893d4b0a194a11d3d13ec18d460f86a237 (patch)
tree4256adfbbcb20675103b94fc2f0217f9f24efa44 /src/cmd/doc
parent43a7a9cf43319b2a473c9c3f604a694965e78903 (diff)
downloadgo-45537d893d4b0a194a11d3d13ec18d460f86a237.tar.xz
cmd/doc: document that json.Decode documents encoding/json.Decoder.Decode
Refine the documentation in cmd/doc and go help doc. Fixes #12377. Change-Id: I670c0a5cf18c9c9d5bb9bb222d8a3dd3722a3934 Reviewed-on: https://go-review.googlesource.com/14121 Reviewed-by: Andrew Gerrand <adg@golang.org>
Diffstat (limited to 'src/cmd/doc')
-rw-r--r--src/cmd/doc/main.go6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/cmd/doc/main.go b/src/cmd/doc/main.go
index dda6aec22c..0985d95b60 100644
--- a/src/cmd/doc/main.go
+++ b/src/cmd/doc/main.go
@@ -11,10 +11,12 @@
// One argument:
// go doc <pkg>
// go doc <sym>[.<method>]
-// go doc [<pkg>].<sym>[.<method>]
+// go doc [<pkg>.]<sym>[.<method>]
+// go doc [<pkg>.][<sym>.]<method>
// The first item in this list that succeeds is the one whose documentation
// is printed. If there is a symbol but no package, the package in the current
-// directory is chosen.
+// directory is chosen. However, if the argument begins with a capital
+// letter it is always assumed to be a symbol in the current directory.
//
// Two arguments:
// go doc <pkg> <sym>[.<method>]