docstub

A house-style rule, off until a decisions table turns it on: it reports a one-line doc comment that only repeats the symbol's name.

What it catches

A one-line doc comment that only repeats the symbol's name.

Dimension

economy: words that carry nothing. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

House style: a stub satisfies a linter and tells the caller nothing. A doc with a marker is exempt.

Default decision

The code is PRF6006. The decision depends on the kind of text judged:

House style ships off: the rule encodes one repository's conventions, not a rule of plain writing. A repository turns it on in its decisions table.

Changing it

A decisions table sets this rule to deny, advise or off, for everything judged or for the files a glob matches. Proofread reads the table from the file its -decisions flag names:

{
  "rules": {"docstub": "deny"},
  "paths": {"blog/**": {"docstub": "off"}}
}

rules applies to every file. A glob in paths applies to the files it matches, and the last match wins. A rule set to off never reports.

Seeing it

A finding names the rule, its code and the decision that applies, and links here:

{"rule": "docstub", "code": "PRF6006", "decision": "deny", "url": "https://eli.gladman.cc/magus/reference/proofread/docstub/"}

proofread rules prints this entry with every other rule's.

See also

• All proofread rules - every rule, grouped by what it checks
• Writing rules - how the rules apply to this repository's pages and pull requests
• The findings contract - the fields every finding carries