close_issue_2
/
tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

go.tools/go/types: document Config.Error better 

LGTM=adonovan
R=adonovan, dsymonds
CC=golang-codereviews
https://golang.org/cl/137960044
This commit is contained in:
Robert Griesemer 2014-09-02 15:53:24 -07:00
parent 79df80a148
commit d7f2ea810f
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
go/types/api.go
View File

@ -102,6 +102,8 @@ type Config struct {
// Secondary errors (for instance, to enumerate all types // Secondary errors (for instance, to enumerate all types
// involved in an invalid recursive type declaration) have // involved in an invalid recursive type declaration) have
// error strings that start with a '\t' character. // error strings that start with a '\t' character.
// If Error == nil, type-checking stops with the first
// error found.
Error func(err error) Error func(err error)
// If Import != nil, it is called for each imported package. // If Import != nil, it is called for each imported package.
@ -321,7 +323,8 @@ func (init *Initializer) String() string {
// Check type-checks a package and returns the resulting package object, // Check type-checks a package and returns the resulting package object,
// the first error if any, and if info != nil, additional type information. // the first error if any, and if info != nil, additional type information.
// The package is marked as complete if no errors occurred, otherwise it is // The package is marked as complete if no errors occurred, otherwise it is
// incomplete. // incomplete. See Config.Error for controlling behavior in the presense of
// errors.
// //
// The package is specified by a list of *ast.Files and corresponding // The package is specified by a list of *ast.Files and corresponding
// file set, and the package path the package is identified with. // file set, and the package path the package is identified with.