1
0
mirror of https://github.com/golang/go synced 2024-11-23 19:00:04 -07:00

go/types: clarify doc string for types.Check

For #12787.

Change-Id: I921d01c8d7d97f3453b25e6d2241a43c5d64f53b
Reviewed-on: https://go-review.googlesource.com/15150
Reviewed-by: Alan Donovan <adonovan@google.com>
This commit is contained in:
Robert Griesemer 2015-09-29 13:17:39 -07:00
parent 0e5b4eb07b
commit bb6be3ab88

View File

@ -297,8 +297,10 @@ func (init *Initializer) String() string {
return buf.String()
}
// Check type-checks a package and returns the resulting package object,
// the first error if any, and if info != nil, additional type information.
// Check type-checks a package and returns the resulting package object and
// the first error if any. Additionally, if info != nil, Check populates each
// of the non-nil maps in the Info struct.
//
// The package is marked as complete if no errors occurred, otherwise it is
// incomplete. See Config.Error for controlling behavior in the presence of
// errors.