diff options
| author | Rob Pike <r@golang.org> | 2015-03-01 08:56:25 -0800 |
|---|---|---|
| committer | Rob Pike <r@golang.org> | 2015-03-01 18:17:53 +0000 |
| commit | 3ee9df799fc76e06b216248735e530dd4e1dc504 (patch) | |
| tree | d7295a52c2903c95f4896a99189a5b546468137c /src/fmt | |
| parent | bc674b3d16cd9e7d25f8b23d0562c954b7a979be (diff) | |
| download | go-3ee9df799fc76e06b216248735e530dd4e1dc504.tar.xz | |
fmt: document existing behavior of nil receivers
If a method called by fmt triggers a panic, the output usually says
so. However, there is heretofore undocumented special treatment for
a panic caused by formatting a nil value with an Error or String
method: the output is simply "<nil>". Document that behavior.
Change-Id: Id0f79dd0b3487f9d1c74a0856727bba5cc342be4
Reviewed-on: https://go-review.googlesource.com/6410
Reviewed-by: David Crawshaw <crawshaw@golang.org>
Diffstat (limited to 'src/fmt')
| -rw-r--r-- | src/fmt/doc.go | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/fmt/doc.go b/src/fmt/doc.go index 9dc2a0d75d..9ba11f4a2b 100644 --- a/src/fmt/doc.go +++ b/src/fmt/doc.go @@ -225,7 +225,9 @@ %!s(PANIC=bad) The %!s just shows the print verb in use when the failure - occurred. + occurred. If the panic is caused by a nil receiver to an Error + or String method, however, the output is the undecorated + string, "<nil>". Scanning |