aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJonathan Amsterdam <jba@google.com>2024-05-16 12:09:38 -0400
committerJonathan Amsterdam <jba@google.com>2024-05-16 18:37:47 +0000
commit06b45781603ec6998012ac63b2c0bda32600f682 (patch)
tree5fb52e98671b2cb5654b6dc4106bd940077d283c /doc
parent78e50d0fa0bc78d197bd1b41e1bdef8c20a03396 (diff)
downloadgo-06b45781603ec6998012ac63b2c0bda32600f682.tar.gz
go-06b45781603ec6998012ac63b2c0bda32600f682.zip
doc/README.md: give example of package-less symbol link
Change-Id: I84d7b6aae7319cc62628a2b5ee752a0680377a15 Reviewed-on: https://go-review.googlesource.com/c/go/+/586135 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
index f608f34fbd..3d0fb86102 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -40,6 +40,7 @@ flagged as a TODO by the automated tooling. That is true even for proposals that
Use the following forms in your markdown:
[http.Request] # symbol documentation; auto-linked as in Go doc strings
+ [Request] # short form, for symbols in the package being documented
[#12345](/issue/12345) # GitHub issues
[CL 6789](/cl/6789) # Gerrit changelists