doclint

Overview ¶

Command doclint keeps documentation about the code as it is. It reads Go comments and Markdown prose (not code, strings or code blocks) and reports wording that narrates how the code got here: what changed, what it did before, what's temporary, who did it and when. History belongs in commit messages; docs and comments say what is and why.

Saying why something stays compatible with a planned change is fine ("kept a pointer so the store can change shape"), since it explains the code today. A line that must use a flagged word says so with "doclint:allow" and a reason, in a comment on that line (or an HTML comment in Markdown).

Usage: go run ./scripts/doclint [dirs or files...]