Documentation
¶
Overview ¶
Package doclint holds the repository's self-checks: tests that read the tree rather than the code, such as whether an environment file is tracked or whether the documentation names identifiers that exist.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExportedIdentifiers ¶
ExportedIdentifiers parses every non-test Go file under root (skipping vendor, testdata and generated SDKs) and returns exports by package name. Two packages sharing a name are merged, which is the right answer for a doc sample that names only the short package name.
Types ¶
type Exported ¶
Exported is what a package exports, by identifier: top-level names and the methods of its types. Methods are keyed as Type.Method as well as Method alone, so a sample calling engine.SignIn resolves by method name.
type Reference ¶
Reference is one pkg.Identifier a doc sample names.
func ReferencesInDocs ¶
ReferencesInDocs extracts every pkg.Identifier selector from the Go fences of the .mdx files under dir, with the line it sits on.
Source Files