diff options
| author | Robert Griesemer <gri@golang.org> | 2015-09-29 13:17:39 -0700 |
|---|---|---|
| committer | Robert Griesemer <gri@golang.org> | 2015-09-29 21:19:22 +0000 |
| commit | bb6be3ab88ebd27afacb79f2ddd731f697a8816e (patch) | |
| tree | f4d182913e72f7d73c8aec645c5b6bc4b1f71b52 | |
| parent | 0e5b4eb07bfecc83de1f54d8ac351ac89caf95ef (diff) | |
| download | go-bb6be3ab88ebd27afacb79f2ddd731f697a8816e.tar.xz | |
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>
| -rw-r--r-- | src/go/types/api.go | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/go/types/api.go b/src/go/types/api.go index 21f885d404..f02b0d0842 100644 --- a/src/go/types/api.go +++ b/src/go/types/api.go @@ -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. |