]> Cypherpunks repositories - gostls13.git/commitdiff
doc/README.md: note simpler symbol links
authorJonathan Amsterdam <jba@google.com>
Wed, 10 Apr 2024 16:19:36 +0000 (12:19 -0400)
committerJonathan Amsterdam <jba@google.com>
Wed, 10 Apr 2024 19:41:39 +0000 (19:41 +0000)
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>
doc/README.md

index 3bb8412ad54f678c077ac5e63db347aa12cb3559..666e0966c9ce2df93603ffb0b45136998fad5ea7 100644 (file)
@@ -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