Documentation
¶
Overview ¶
Command godoccheck fails on an exported symbol with no doc comment.
It runs over the modules somebody else imports — runtime, auth, migrate, rigclient — where the godoc is the documentation for the Go surface rather than commentary on it. `make godoc-check` is the entry point.
It parses files by path rather than loading packages, which is what lets a program in the root module check directories belonging to four other modules without a type checker, a build, or a module resolution step. That also rules out go/doc, whose ast.Package has been deprecated since Go 1.22.
What it asks is only whether a symbol has a doc, never what the doc says. The form of a comment is a decision this repository already made — prose, not "Foo does..." boilerplate, which is why ST1000 and ST1020-ST1022 are off in .golangci.yml — and struct fields are documented where the name leaves a question open, which is a judgement no tool makes well. A check that produced a hundred "// ID is the ID." lines would leave the next reader trusting the doc comments less, not more.
Source Files