code review 6218047: godoc: slightly smarter synopsis extraction

godoc: slightly smarter synopsis extraction

Ignore synopses that start with
"Copyright", "All rights", and "Author".

[gri, 2012-05-17 22:45:19]

Hello rsc@golang.org (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go

[rsc, 2012-05-17 23:11:11]

I'm a little worried about Synopsis skipping over text. If I write
// Foo bar.  You need package quux to use this.  (Package quux does x.)
then it looks like this code will pull out "Package quux does x.",
which may not be intended.

Maybe instead we could just make a requirement about the beginning of the text:

doc := oldSynopsis()
if !strings.HasPrefix(doc, "Package ") {
    doc = ""
}

This sounds like what the CL description says, so maybe I
misunderstand the code.

Russ

[gri, 2012-05-18 18:01:45]

Hello rsc@golang.org (cc: golang-dev@googlegroups.com),

Please take another look.

[rsc, 2012-05-22 03:05:32]

LGTM

[gri, 2012-05-22 17:04:17]

*** Submitted as http://code.google.com/p/go/source/detail?r=b13f9b2f6794 ***

godoc: slightly smarter synopsis extraction

Ignore synopses that start with
"Copyright", "All rights", and "Author".

R=rsc
CC=golang-dev
http://codereview.appspot.com/6218047