diff options
author | Nigel Tao <nigeltao@golang.org> | 2011-06-17 10:51:10 +1000 |
---|---|---|
committer | Nigel Tao <nigeltao@golang.org> | 2011-06-17 10:51:10 +1000 |
commit | ca91ce2d856f79d6cc1cb2d67ed0daef2a89b377 (patch) | |
tree | 38e78adb125b95875988356dfcccfa8658374347 | |
parent | 278952c393387290ad43c028b54888329438936c (diff) | |
download | go-ca91ce2d856f79d6cc1cb2d67ed0daef2a89b377.tar.gz go-ca91ce2d856f79d6cc1cb2d67ed0daef2a89b377.zip |
doc/effective_go: add a note about prefixing error strings with their
package name.
R=r, rsc
CC=golang-dev
https://golang.org/cl/4630042
-rw-r--r-- | doc/effective_go.html | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/effective_go.html b/doc/effective_go.html index 0f9b70729e..9a674c72bf 100644 --- a/doc/effective_go.html +++ b/doc/effective_go.html @@ -233,9 +233,9 @@ Since the whole declaration is presented, such a comment can often be perfunctor <pre> // Error codes returned by failures to parse an expression. var ( - ErrInternal = os.NewError("internal error") - ErrUnmatchedLpar = os.NewError("unmatched '('") - ErrUnmatchedRpar = os.NewError("unmatched ')'") + ErrInternal = os.NewError("regexp: internal error") + ErrUnmatchedLpar = os.NewError("regexp: unmatched '('") + ErrUnmatchedRpar = os.NewError("regexp: unmatched ')'") ... ) </pre> @@ -2674,6 +2674,13 @@ it is much more informative than the plain </p> <p> +When feasible, error strings should identify their origin, such as by having +a prefix naming the package that generated the error. For example, in package +image, the string representation for a decoding error due to an unknown format +is "image: unknown format". +</p> + +<p> Callers that care about the precise error details can use a type switch or a type assertion to look for specific errors and extract details. For <code>PathErrors</code> |