]> Cypherpunks repositories - gostls13.git/commitdiff
go/doc: update ToHTML doc comment
authorRuss Cox <rsc@golang.org>
Thu, 3 Oct 2013 13:49:12 +0000 (09:49 -0400)
committerRuss Cox <rsc@golang.org>
Thu, 3 Oct 2013 13:49:12 +0000 (09:49 -0400)
Update #5429

R=golang-dev, r, dan.kortschak
CC=golang-dev
https://golang.org/cl/14293043

src/pkg/go/doc/comment.go

index c4b7e6ae6e17d0f24487aa4e503d0af7b1c925c1..5c8c43e0c1aa6ee77469512c31460d6ace89a0de 100644 (file)
@@ -239,9 +239,14 @@ func anchorID(line string) string {
 // nor to have trailing spaces at the end of lines.
 // The comment markers have already been removed.
 //
-// Turn each run of multiple \n into </p><p>.
-// Turn each run of indented lines into a <pre> block without indent.
-// Enclose headings with header tags.
+// Each span of unindented non-blank lines is converted into
+// a single paragraph. There is one exception to the rule: a span that
+// consists of a single line, is followed by another paragraph span,
+// begins with a capital letter, and contains no punctuation
+// is formatted as a heading.
+//
+// A span of indented lines is converted into a <pre> block,
+// with the common indent prefix removed.
 //
 // URLs in the comment text are converted into links; if the URL also appears
 // in the words map, the link is taken from the map (if the corresponding map