package sample

Import Path
	golang.org/x/pkgsite/internal/testing/sample (on go.dev)

Dependency Relation
	imports 18 packages, and imported by one package

Involved Source Files

	   d➜ sample.go
		Package sample provides functionality for generating sample values of
		the types contained in the internal package.
Package-Level Functions (total 21, in which 18 are exported)

	 func AddLicense(m *internal.Module, lic *licenses.License)
	 func AddPackage(m *internal.Module, pkg *internal.Unit) *internal.Module
	 func AddUnit(m *internal.Module, u *internal.Unit)
	 func DefaultModule() *internal.Module
	 func DefaultVersionMap() *internal.VersionMap
	 func Documentation(goos, goarch, fileContents string) *internal.Documentation
		Documentation returns a Documentation value for the given Go source.
		It panics if there are errors parsing or encoding the source.

	 func Imports() []string
	 func LicenseMetadata() []*licenses.Metadata
	 func Licenses() []*licenses.License
	 func Module(modulePath, version string, suffixes ...string) *internal.Module
		Module creates a Module with the given path and version.
		The list of suffixes is used to create Units within the module.

	 func ModuleInfo(modulePath, versionString string) *internal.ModuleInfo
	 func NowTruncated() time.Time
		NowTruncated returns time.Now() truncated to Microsecond precision.

		This makes it easier to work with timestamps in PostgreSQL, which have
		Microsecond precision:
		  https://www.postgresql.org/docs/9.1/datatype-datetime.html

	 func PackageMeta(fullPath string) *internal.PackageMeta
	 func ReplaceLicense(m *internal.Module, lic *licenses.License)
		ReplaceLicense replaces all licenses having the same file path as lic with lic.

	 func UnitEmpty(path, modulePath, version string) *internal.Unit
	 func UnitForModuleRoot(m *internal.ModuleInfo) *internal.Unit
	 func UnitForPackage(path, modulePath, version, name string, isRedistributable bool) *internal.Unit
		UnitForPackage constructs a unit with the given module path and suffix.

		If modulePath is the standard library, the package path is the
		suffix, which must not be empty. Otherwise, the package path
		is the concatenation of modulePath and suffix.

		The package name is last component of the package path.

	 func UnitMeta(path, modulePath, version, name string, isRedistributable bool) *internal.UnitMeta
	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func constructFullPath(modulePath, suffix string) string
	 func coveragePercentEqual(a, b float64) bool
		coveragePercentEqual considers two floats the same if they are within 4
		percentage points, and both are on the same side of 90% (our threshold).

	 func replaceLicense(lic *licenses.License, lics []*licenses.License)
Package-Level Variables (total 24, all are exported)

	  var API []*internal.Symbol
		These sample values can be used to construct test cases.

	  var CommitTime time.Time
		These sample values can be used to construct test cases.

	  var Constant *internal.Symbol
		These sample values can be used to construct test cases.

	  var Doc *internal.Documentation
		These sample values can be used to construct test cases.

	  var DocContents string
		These sample values can be used to construct test cases.

	  var Function *internal.Symbol
		These sample values can be used to construct test cases.

	  var FunctionNew *internal.Symbol
		These sample values can be used to construct test cases.

	  var GOARCH string
		These sample values can be used to construct test cases.

	  var GOOS string
		These sample values can be used to construct test cases.

	  var LicenseCmpOpts []cmp.Option
		LicenseCmpOpts are options to use when comparing licenses with the cmp package.

	  var LicenseFilePath string
		These sample values can be used to construct test cases.

	  var LicenseType string
		These sample values can be used to construct test cases.

	  var ModulePath string
		These sample values can be used to construct test cases.

	  var NonRedistributableLicense *licenses.License
		These sample values can be used to construct test cases.

	  var PackageName string
		These sample values can be used to construct test cases.

	  var PackagePath string
		These sample values can be used to construct test cases.

	  var ReadmeContents string
		These sample values can be used to construct test cases.

	  var ReadmeFilePath string
		These sample values can be used to construct test cases.

	  var RepositoryURL string
		These sample values can be used to construct test cases.

	  var Suffix string
		These sample values can be used to construct test cases.

	  var Type *internal.Symbol
		These sample values can be used to construct test cases.

	  var V1Path string
		These sample values can be used to construct test cases.

	  var Variable *internal.Symbol
		These sample values can be used to construct test cases.

	  var VersionString string
		These sample values can be used to construct test cases.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.