doccheck

package

v0.0.1 Latest Latest Go to latest Published: Nov 3, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ChristopherDavenport/agentimport

Links

Open Source Insights

Documentation ¶

Overview ¶

Package doccheck holds the converters to their documents: every finding code a conversion reports must be listed in the source's docs/formats document, every gap code in docs/incompatibilities.md as well, and every identity member a conversion reports in its document's Identity section.

Index ¶

func Check(t testing.TB, source string, r *agentimport.Report)
func Codes(path string) (map[string]bool, error)
func IdentityPaths(path string) (map[string]bool, error)
func Root() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Check ¶

func Check(t testing.TB, source string, r *agentimport.Report)

Check fails t for every code in r that docs/formats/<source>.md does not list, and every gap code docs/incompatibilities.md does not. Codes in the agentimport/ namespace, which the shared builder reports, are documented in docs/formats/README.md.

func Codes ¶

func Codes(path string) (map[string]bool, error)

Codes returns the finding codes a document's tables list, as the first cell of a row.

func IdentityPaths ¶

func IdentityPaths(path string) (map[string]bool, error)

IdentityPaths returns the member paths a document's Identity section lists, as the first cell of a row of its table.

func Root ¶

func Root() string

Root is the repository root.

Types ¶

This section is empty.

Source Files ¶

View all Source files

doccheck.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL