From: Jonathan Amsterdam <jba@google.com>
Date: Wed, 10 Apr 2024 16:19:36 +0000 (-0400)
Subject: doc/README.md: note simpler symbol links
X-Git-Tag: go1.23rc1~650
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=5b5d6f87a8a19848b367a0e0d8e56c0141c02193;p=gostls13.git

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>
---

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