code review 7334044: cmd/godoc: add support for doc.Package.Notes

cmd/godoc: add support for doc.Package.Notes

Add support for displaying the notes of the form 'MARKER(userid): comment' now collected by the go/doc package. Any two or more uppercase letters are recognised as a marker.

[cnicolaou, 2013-02-14 18:35:58]

Hello golang-dev@googlegroups.com,

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

[bradfitz, 2013-02-14 18:47:06]

Also start this CL description with "cmd/godoc: "

On Thu, Feb 14, 2013 at 10:35 AM, <cnicolaou@google.com> wrote:

> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://code.google.com/p/go
>
>
> Description:
> Add support for displaying the annotations of the form 'MARKER(userid):
> comment' now collected
> by the go/doc package. Any two or more uppercase letters are now
> recognised as a marker.
>
> Please review this at
https://codereview.appspot.**com/7334044/<https://codereview.appspot.com/7334...
>
> Affected files:
>   M lib/godoc/package.html
>   M lib/godoc/package.txt
>
>
> Index: lib/godoc/package.html
> ==============================**==============================**=======
> --- a/lib/godoc/package.html
> +++ b/lib/godoc/package.html
> @@ -73,6 +73,11 @@
>                         {{if .Bugs}}
>                                 <dd><a href="#pkg-bugs">Bugs</a></dd>
>                         {{end}}
> +                       {{if .Annotations}}
> +                                {{range $marker, $item := .Annotations}}
> +                               <dd><a href="#pkg-{{$marker}}">{{$**
> marker}}</a></dd>
> +                                {{end}}
> +                       {{end}}
>                         </dl>
>                         </div><!-- #manual-nav -->
>
> @@ -168,6 +173,14 @@
>                 {{comment_html .}}
>                 {{end}}
>         {{end}}
> +       {{with .Annotations}}
> +                {{range $marker, $content := .}}
> +                   <h2 id="pkg-{{$marker}}">{{$**marker}}</h2>
> +                   {{range .}}
> +                   {{comment_html .}}
> +                    {{end}}
> +               {{end}}
> +       {{end}}
>  {{end}}
>
>  {{with .PAst}}
> Index: lib/godoc/package.txt
> ==============================**==============================**=======
> --- a/lib/godoc/package.txt
> +++ b/lib/godoc/package.txt
> @@ -61,7 +61,12 @@
>  BUGS
>
>  {{range .}}{{comment_text . "    " "\t"}}
> -{{end}}{{end}}{{end}}{{/*
> +{{end}}{{end}}{{with .Annotations}}
> +{{range $marker, $content := .}}
> +{{$marker}}
> +
> +{{range $content}}{{comment_text . "    " "\t"}}
> +{{end}}{{end}}{{end}}{{end}}{**{/*
>
>  ------------------------------**---------
>
>
>
> --
>
> ---You received this message because you are subscribed to the Google
> Groups "golang-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to
golang-dev+unsubscribe@**googlegroups.com<golang-dev%2Bunsubscribe@googlegrou...
> .
> For more options, visit
https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/o...
> .
>
>
>

[cnicolaou, 2013-02-14 19:52:38]

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

Please take another look.

[gri, 2013-02-14 21:13:09]

LGTM

https://codereview.appspot.com/7334044/diff/9001/lib/godoc/package.html
File lib/godoc/package.html (right):

https://codereview.appspot.com/7334044/diff/9001/lib/godoc/package.html#newco...
lib/godoc/package.html:179: {{range .}}
{{range $content}} ?

[gri, 2013-02-15 04:35:33]

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

cmd/godoc: add support for doc.Package.Notes

Add support for displaying the notes of the form 'MARKER(userid): comment' now
collected by the go/doc package. Any two or more uppercase letters are
recognised as a marker.

R=gri, rsc, bradfitz
CC=golang-dev
https://codereview.appspot.com/7334044

Committer: Robert Griesemer <gri@golang.org>