aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuss Cox <rsc@golang.org>2022-02-08 15:28:09 -0500
committerRuss Cox <rsc@golang.org>2022-02-08 20:28:51 +0000
commit1ded8b8a987d78f70454ec924c30ac9c1ab26308 (patch)
treea6c0d268b628bc0a2a6c4806821b6bac3f7e11b5
parentca97ec8d5b5679e9444bcebf6d18192dc8a186d0 (diff)
downloadgo-x-proposal-1ded8b8a987d78f70454ec924c30ac9c1ab26308.tar.xz
design/51082-godocfmt: add link to GitHub rendering with images
Sigh. Change-Id: I771d6c075400c83a90b140402257a349fe2ae7a8 Reviewed-on: https://go-review.googlesource.com/c/proposal/+/384163 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Russ Cox <rsc@golang.org>
-rw-r--r--design/51082-godocfmt.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/design/51082-godocfmt.md b/design/51082-godocfmt.md
index 4347c32..f6c9d9e 100644
--- a/design/51082-godocfmt.md
+++ b/design/51082-godocfmt.md
@@ -38,6 +38,9 @@ And package doc comments (and others) can be rewritten to link to specific symbo
<tr><td><img src="51082/doclink.png" width="366" height="383">
</table>
+(Gerrit's Markdown viewer does not render the images.
+See [the GitHub rendering](https://github.com/golang/proposal/blob/master/design/51082-godocfmt.md) instead.)
+
## Background
Go's doc comments today support plain text and preformatted (HTML \<pre>) blocks,