mirror of
https://github.com/golang/go.git
synced 2025-12-08 06:10:04 +00:00
go/importer: document limitations of this API
Arguably it should be deprecated, but that's a process. Updates #71272 Change-Id: I69de1f9709c45dfea0fe67d96a7bd15d3df4e2f1 Reviewed-on: https://go-review.googlesource.com/c/go/+/643795 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Robert Findley <rfindley@google.com> Auto-Submit: Alan Donovan <adonovan@google.com>
This commit is contained in:
parent
f6d17c5400
commit
70b603f4d2
1 changed files with 13 additions and 0 deletions
|
|
@ -3,6 +3,13 @@
|
|||
// license that can be found in the LICENSE file.
|
||||
|
||||
// Package importer provides access to export data importers.
|
||||
//
|
||||
// These functions, which are mostly deprecated, date from before the
|
||||
// introduction of modules in release Go 1.11. They should no longer
|
||||
// be relied on except for use in test cases using small programs that
|
||||
// depend only on the standard library. For reliable module-aware
|
||||
// loading of type information, use the packages.Load function from
|
||||
// golang.org/x/tools/go/packages.
|
||||
package importer
|
||||
|
||||
import (
|
||||
|
|
@ -79,6 +86,12 @@ func For(compiler string, lookup Lookup) types.Importer {
|
|||
|
||||
// Default returns an Importer for the compiler that built the running binary.
|
||||
// If available, the result implements [types.ImporterFrom].
|
||||
//
|
||||
// Default may be convenient for use in the simplest of cases, but
|
||||
// most clients should instead use [ForCompiler], which accepts a
|
||||
// [token.FileSet] from the caller; without it, all position
|
||||
// information derived from the Importer will be incorrect and
|
||||
// misleading. See also the package documentation.
|
||||
func Default() types.Importer {
|
||||
return For(runtime.Compiler, nil)
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue