From 4d3c9990867d77844fba1bbf0d8f7794f2492d11 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Wed, 2 Nov 2011 15:03:36 +0900 Subject: [PATCH] builtin: document built-in error type R=golang-dev, dsymonds, r CC=golang-dev https://golang.org/cl/5307080 --- src/pkg/builtin/builtin.go | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/pkg/builtin/builtin.go b/src/pkg/builtin/builtin.go index 07acce4f700..59e13a5b83d 100644 --- a/src/pkg/builtin/builtin.go +++ b/src/pkg/builtin/builtin.go @@ -3,10 +3,10 @@ // license that can be found in the LICENSE file. /* - Package builtin provides documentation for Go's built-in functions. - The functions documented here are not actually in package builtin + Package builtin provides documentation for Go's predeclared identifiers. + The items documented here are not actually in package builtin but their descriptions here allow godoc to present documentation - for the language's special functions. + for the language's special identifiers. */ package builtin @@ -133,3 +133,9 @@ func panic(v interface{}) // nil. Thus the return value from recover reports whether the goroutine is // panicking. func recover() interface{} + +// The error built-in interface type is the conventional interface for +// representing an error condition, with the nil value representing no error. +type error interface { + Error() string +}