go/packages: add a clarification about the order of Syntax
Change-Id: I4b124fe48eac7295a4eee75eede4e2db94183bb9
Reviewed-on: https://go-review.googlesource.com/c/tools/+/375376
Trust: Michael Matloob <matloob@golang.org>
Run-TryBot: Michael Matloob <matloob@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
diff --git a/go/packages/packages.go b/go/packages/packages.go
index d545b13..1b5424e 100644
--- a/go/packages/packages.go
+++ b/go/packages/packages.go
@@ -328,6 +328,9 @@
// The NeedSyntax LoadMode bit populates this field for packages matching the patterns.
// If NeedDeps and NeedImports are also set, this field will also be populated
// for dependencies.
+ //
+ // Syntax is kept in the same order as CompiledGoFiles, with the caveat that nils are
+ // removed. If parsing returned nil, Syntax may be shorter than CompiledGoFiles.
Syntax []*ast.File
// TypesInfo provides type information about the package's syntax trees.
