]> Cypherpunks repositories - gostls13.git/commitdiff
go/doc: permit a package synopsis to end with ":\n".
authorDavid Symonds <dsymonds@golang.org>
Tue, 13 Aug 2013 06:20:17 +0000 (16:20 +1000)
committerDavid Symonds <dsymonds@golang.org>
Tue, 13 Aug 2013 06:20:17 +0000 (16:20 +1000)
R=gri, r
CC=golang-dev
https://golang.org/cl/12822043

src/pkg/go/doc/synopsis.go
src/pkg/go/doc/synopsis_test.go

index 2d18174393e67201f002a8ae6f68d7e08d398464..cef05f5c14d03e3f06958136560d3183c7b5440b 100644 (file)
@@ -10,12 +10,15 @@ import (
 )
 
 // firstSentenceLen returns the length of the first sentence in s.
-// The sentence ends after the first period followed by space and
-// not preceded by exactly one uppercase letter.
-//
+// The sentence ends at the first colon followed by a newline,
+// or at the first period followed by space and not preceded by
+// exactly one uppercase letter.
 func firstSentenceLen(s string) int {
        var ppp, pp, p rune
        for i, q := range s {
+               if p == ':' && q == '\n' {
+                       return i
+               }
                if q == '\n' || q == '\r' || q == '\t' {
                        q = ' '
                }
index fd7081a07c2c6adc3758192c2b6ed50c9ecbf1e7..d806fe45bb167cf8208e74052f1de9011532b2a4 100644 (file)
@@ -29,6 +29,7 @@ var tests = []struct {
        {"Package Καλημέρα κόσμε.", 36, "Package Καλημέρα κόσμε."},
        {"Package こんにちは 世界\n", 31, "Package こんにちは 世界"},
        {"Package foo does bar.", 21, "Package foo does bar."},
+       {"Package foo does these things:\n  - a\n  - b", 30, "Package foo does these things:"},
        {"Copyright 2012 Google, Inc. Package foo does bar.", 27, ""},
        {"All Rights reserved. Package foo does bar.", 20, ""},
        {"All rights reserved. Package foo does bar.", 20, ""},