Skip to content
goflag
Documentation
Rule catalogue

description.length

Keep descriptions between 50 and 160 characters

warningper pageheuristic

Why it matters

Too short and the snippet gets padded with body text you did not choose; too long and it is cut. The window is a heuristic, not a specification; see the note on rigor below.

What the finding looks like

The message goflag prints, with example values substituted.

warn description.length Description is 31 characters — short of the recommended 50–160 window.

How to fix it

This rule ships no snippet, because the remedy is a judgement rather than a line of code: the finding tells you what is out of range, and what to put there is yours to decide.

Says who?

This rule is heuristic, and it cites the documentsbelow. Nothing here is goflag’s opinion of what a good page looks like — if you disagree with a finding, this is what you are disagreeing with.