diff options
author | Jonathan Amsterdam <jba@google.com> | 2024-04-10 12:19:36 -0400 |
---|---|---|
committer | Jonathan Amsterdam <jba@google.com> | 2024-04-10 19:41:39 +0000 |
commit | 5b5d6f87a8a19848b367a0e0d8e56c0141c02193 (patch) | |
tree | ab4365fe888cda29111558727949a9a2ef91d668 /doc | |
parent | 3504da456591acf1b1ab479d4a5b2c91345a7f22 (diff) | |
download | go-5b5d6f87a8a19848b367a0e0d8e56c0141c02193.tar.gz go-5b5d6f87a8a19848b367a0e0d8e56c0141c02193.zip |
doc/README.md: note simpler symbol links
Document that links to symbols in the standard library can be
written as "[foo]", without the actual link.
For #64169.
Change-Id: I9d8a33e85df70037320a169d55a2bb4a8a981ebf
Reviewed-on: https://go-review.googlesource.com/c/go/+/577915
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/README.md b/doc/README.md index 3bb8412ad5..666e0966c9 100644 --- a/doc/README.md +++ b/doc/README.md @@ -27,9 +27,9 @@ ideally referring to a person with the responsibility to complete the note. Use the following forms in your markdown: - [`http.Request`](/pkg/net/http#Request) # symbol documentation - [#12345](/issue/12345) # GitHub issues - [CL 6789](/cl/6789) # Gerrit changelists + [http.Request] # symbol documentation; auto-linked as in Go doc strings + [#12345](/issue/12345) # GitHub issues + [CL 6789](/cl/6789) # Gerrit changelists ## For the release team |