code review 4128058: go spec, effective go: cleanups

go spec, effective go: cleanups

Removed most of the detailed examples about handing panics
from the go spec since it's now covered by Effective Go.

[gri, 2011-02-03 22:36:24]

Hello r, rsc, iant, ken2 (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://go.googlecode.com/hg/

[r, 2011-02-03 23:38:28]

http://codereview.appspot.com/4128058/diff/3003/doc/effective_go.html
File doc/effective_go.html (right):

http://codereview.appspot.com/4128058/diff/3003/doc/effective_go.html#newcode...
doc/effective_go.html:2763: by the outside panic.
move this down and shorten it

Because recover always returns nil unless called directly from a deferred
function, deferred code can call library routines that themselves use panic
and recover without failing.  As an example, the deferred
function in <code>safelyDo</code> might call a looging [perhaps you meant
logging] function before
 calling <code>recover</code>, and that logging code would run unaffected
by the panicking state.

http://codereview.appspot.com/4128058/diff/3003/doc/effective_go.html#newcode...
doc/effective_go.html:2767: Note that with this recovery pattern in place, the
<code>do</code>
s/Note that with this/With our/

[r, 2011-02-03 23:38:45]

actually don't move it. it can stay where it is.

[gri, 2011-02-03 23:48:21]

updated.
PTAL

On Thu, Feb 3, 2011 at 3:38 PM, <r@golang.org> wrote:

>
> http://codereview.appspot.com/4128058/diff/3003/doc/effective_go.html
> File doc/effective_go.html (right):
>
>
>
http://codereview.appspot.com/4128058/diff/3003/doc/effective_go.html#newcode...
> doc/effective_go.html:2763: by the outside panic.
> move this down and shorten it
>
> Because recover always returns nil unless called directly from a
> deferred function, deferred code can call library routines that
> themselves use panic
> and recover without failing.  As an example, the deferred
> function in <code>safelyDo</code> might call a looging [perhaps you
> meant logging] function before
>  calling <code>recover</code>, and that logging code would run
> unaffected
> by the panicking state.
>
>
>
http://codereview.appspot.com/4128058/diff/3003/doc/effective_go.html#newcode...
> doc/effective_go.html:2767: Note that with this recovery pattern in
> place, the <code>do</code>
> s/Note that with this/With our/
>
>
> http://codereview.appspot.com/4128058/
>

[r, 2011-02-03 23:52:22]

http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html
File doc/effective_go.html (right):

http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html#newcode...
doc/effective_go.html:2754: Because <code>recover</code> always returns nil
unless called directly from
<code>nil</code> ?

http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html#newcode...
doc/effective_go.html:2756: use panic and recover without failing.  As an
example, the deferred
ditto for panic and recover

[r, 2011-02-03 23:52:22]

http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html
File doc/effective_go.html (right):

http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html#newcode...
doc/effective_go.html:2754: Because <code>recover</code> always returns nil
unless called directly from
<code>nil</code> ?

http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html#newcode...
doc/effective_go.html:2756: use panic and recover without failing.  As an
example, the deferred
ditto for panic and recover

[gri, 2011-02-04 00:08:33]

PTAL
- gri

On Thu, Feb 3, 2011 at 3:52 PM, <r@golang.org> wrote:

>
> http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html
> File doc/effective_go.html (right):
>
>
>
http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html#newcode...
> doc/effective_go.html:2754: Because <code>recover</code> always returns
> nil unless called directly from
> <code>nil</code> ?
>
>
>
http://codereview.appspot.com/4128058/diff/7002/doc/effective_go.html#newcode...
> doc/effective_go.html:2756: use panic and recover without failing.  As
> an example, the deferred
> ditto for panic and recover
>
> http://codereview.appspot.com/4128058/
>

[r, 2011-02-04 00:09:41]

LGTM

[rsc, 2011-02-04 13:19:16]

LGTM

http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html
File doc/go_spec.html (right):

http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html#newcode4666
doc/go_spec.html:4666: panic("should not reach here")
s/should not reach here/unreachable/
to make it a common example

http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html#newcode4673
doc/go_spec.html:4673: <em>inside</em> a deferred function (but not any function
called by it) stops
This is the only <em> in the document.  <i>?

http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html#newcode4677
doc/go_spec.html:4677: not stop a panicking sequence.  In this case, when the
goroutine
s/when/or when/

The when clause here sounds like it is a restatement of the meaning of "this
case".  It wasn't until I looked at the old text that I realized this new text
was a list of 3 alternatives, not just 2.

[gri, 2011-02-04 16:42:42]

On Fri, Feb 4, 2011 at 5:19 AM, <rsc@golang.org> wrote:

> LGTM
>
>
>
>
> http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html
> File doc/go_spec.html (right):
>
>
> http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html#newcode4666
> doc/go_spec.html:4666: panic("should not reach here")
> s/should not reach here/unreachable/
> to make it a common example
>
Done.

>
>
> http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html#newcode4673
> doc/go_spec.html:4673: <em>inside</em> a deferred function (but not any
> function called by it) stops
> This is the only <em> in the document.  <i>?
>
Done.

>
>
> http://codereview.appspot.com/4128058/diff/10001/doc/go_spec.html#newcode4677
> doc/go_spec.html:4677: not stop a panicking sequence.  In this case,
> when the goroutine
> s/when/or when/
>
Done.

>
> The when clause here sounds like it is a restatement of the meaning of
> "this case".  It wasn't until I looked at the old text that I realized
> this new text was a list of 3 alternatives, not just 2.
>
>
> http://codereview.appspot.com/4128058/
>

[gri, 2011-02-04 16:43:24]

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

go spec, effective go: cleanups

Removed most of the detailed examples about handing panics
from the go spec since it's now covered by Effective Go.

R=r, rsc, iant, ken2
CC=golang-dev
http://codereview.appspot.com/4128058