diff options
| author | Russ Cox <rsc@golang.org> | 2022-02-09 06:13:34 -0500 |
|---|---|---|
| committer | Russ Cox <rsc@golang.org> | 2022-02-09 11:14:12 +0000 |
| commit | 2b9cc15f0f5c199f2578694ce34fc7ac4eb7d712 (patch) | |
| tree | 6e97c6d0b428df114dcce6a590c36c82bfad93a4 | |
| parent | 1ded8b8a987d78f70454ec924c30ac9c1ab26308 (diff) | |
| download | go-x-proposal-2b9cc15f0f5c199f2578694ce34fc7ac4eb7d712.tar.xz | |
design/51082-godocfmt: add indented non-heading example
Change-Id: I532ae825ee7c48909ff53137669ffe80caf5fcf3
Reviewed-on: https://go-review.googlesource.com/c/proposal/+/384434
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.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/design/51082-godocfmt.md b/design/51082-godocfmt.md index f6c9d9e..8a9c586 100644 --- a/design/51082-godocfmt.md +++ b/design/51082-godocfmt.md @@ -232,6 +232,8 @@ Here are some examples of variations that do not satisfy the rule and are theref In the middle of a span of non-blank lines, # this is not a heading either. + # This is not a heading, because it is indented. + The old heading rule will remain valid, which is acceptable since it mainly has false negatives, not false positives. This will keep existing doc comments rendering as they do today. |