code review 7066053: html/template: Improve documentation of template.Must.

html/template: Clarifying references to "text/template" in the documentation.

Fixes issue 4634.

[francesc, 2013-01-08 19:02:11]

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

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

[kevlar, 2013-01-08 22:07:02]

https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
File src/pkg/html/template/template.go (right):

https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
src/pkg/html/template/template.go:271: // Must panics if err is non-nil.
Otherwise, t is returned.
I may be alone in this, but I think the positive case should go first.
// Must returns t unless err is non-nil, in which case
// Must will panic with err.

I don't think the rest is necessary, though if it is kept I would write
something like:
//
// Must is useful for initializing top-level package templates.

and leave out the example.

[adg, 2013-01-09 00:18:11]

https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
File src/pkg/html/template/template.go (right):

https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
src/pkg/html/template/template.go:271: // Must panics if err is non-nil.
Otherwise, t is returned.
Use the same text as http://golang.org/pkg/text/template/#Must

    Must is a helper that wraps a call to a function returning (*Template,
    error) and panics if the error is non-nil. It is intended for use in
    variable initializations such as

        var t = template.Must(template.New("name").Parse("html"))

[francesc, 2013-01-10 09:42:08]

On 2013/01/09 00:18:11, adg wrote:
>
https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
> File src/pkg/html/template/template.go (right):
> 
>
https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
> src/pkg/html/template/template.go:271: // Must panics if err is non-nil.
> Otherwise, t is returned.
> Use the same text as http://golang.org/pkg/text/template/#Must
> 
>     Must is a helper that wraps a call to a function returning (*Template,
>     error) and panics if the error is non-nil. It is intended for use in
>     variable initializations such as
> 
>         var t = template.Must(template.New("name").Parse("html"))

Done. Using slightly different text, which is the one on HEAD for text/template

[francesc, 2013-01-10 10:22:13]

On 2013/01/10 09:42:08, gocampoy wrote:
> On 2013/01/09 00:18:11, adg wrote:
> >
>
https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
> > File src/pkg/html/template/template.go (right):
> > 
> >
>
https://codereview.appspot.com/7066053/diff/7002/src/pkg/html/template/templa...
> > src/pkg/html/template/template.go:271: // Must panics if err is non-nil.
> > Otherwise, t is returned.
> > Use the same text as http://golang.org/pkg/text/template/#Must
> > 
> >     Must is a helper that wraps a call to a function returning (*Template,
> >     error) and panics if the error is non-nil. It is intended for use in
> >     variable initializations such as
> > 
> >         var t = template.Must(template.New("name").Parse("html"))
> 
> Done. Using slightly different text, which is the one on HEAD for
text/template

I modified some other unclear references to "text/template". PTAL

[adg, 2013-01-10 23:33:24]

LGTM

https://codereview.appspot.com/7066053/diff/4004/src/pkg/html/template/templa...
File src/pkg/html/template/template.go (right):

https://codereview.appspot.com/7066053/diff/4004/src/pkg/html/template/templa...
src/pkg/html/template/template.go:241: // as FuncMap in "text/template", copied
here so clients need not import
s/in/from/

[francesc, 2013-01-14 12:11:29]

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

html/template: Clarifying references to "text/template" in the documentation.

Fixes issue 4634.

R=adg, kevlar
CC=golang-dev
https://codereview.appspot.com/7066053