]> Cypherpunks repositories - gostls13.git/commitdiff
doc/README.md: give example of package-less symbol link
authorJonathan Amsterdam <jba@google.com>
Thu, 16 May 2024 16:09:38 +0000 (12:09 -0400)
committerJonathan Amsterdam <jba@google.com>
Thu, 16 May 2024 18:37:47 +0000 (18:37 +0000)
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>
doc/README.md

index f608f34fbdbf2ab0dd9bd47dc962fce9bed817e3..3d0fb861029cde1ba7db5a677eee2967a9f4d8ec 100644 (file)
@@ -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