doctag

package

v0.43.0 Latest Latest Go to latest Published: Nov 13, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

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

Repository

github.com/pyvvo/funcd

Links

Open Source Insights

Documentation ¶

Overview ¶

Package doctag pins an API field's or a config key's description to the named constants it copies (ADR-0323 Decision 4): the test of the package that owns a constant names the field and the constant, so that a changed constant fails until the description follows.

Index ¶

func Names(t testing.TB, owner reflect.Type, field string, want ...string)
func NamesAt(t testing.TB, root reflect.Type, path string, want ...string)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Names ¶

func Names(t testing.TB, owner reflect.Type, field string, want ...string)

Names fails t unless the doc tag of owner's field holds each of want, not as part of a longer word or number.

func NamesAt ¶

func NamesAt(t testing.TB, root reflect.Type, path string, want ...string)

NamesAt is Names for the field at a dotted path of json names under root, such as kvstore.backup.interval or auth.credentials[].tokenFile.

Types ¶

This section is empty.

Source Files ¶

View all Source files

doctag.go

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