]> Cypherpunks repositories - gostls13.git/commitdiff
go/types: clarify doc string for types.Check
authorRobert Griesemer <gri@golang.org>
Tue, 29 Sep 2015 20:17:39 +0000 (13:17 -0700)
committerRobert Griesemer <gri@golang.org>
Tue, 29 Sep 2015 21:19:22 +0000 (21:19 +0000)
For #12787.

Change-Id: I921d01c8d7d97f3453b25e6d2241a43c5d64f53b
Reviewed-on: https://go-review.googlesource.com/15150
Reviewed-by: Alan Donovan <adonovan@google.com>
src/go/types/api.go

index 21f885d4044002f996731a479c8292ec279572b7..f02b0d0842aeb73705b764a93f4a06e8aa6819e1 100644 (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.