slop/marketing-words
Documentation is free of marketing filler
| Severity | info |
| Tiers | all |
| Stacks | any |
| Scope | root |
| Kind | expr |
| Source | library v0.8.0 |
| Selected by | fleetlint-slop@v0.8.0 |
Requirement
Markdown documentation does not use marketing filler: seamless, blazing fast, cutting-edge, state-of-the-art, leverage, effortless, supercharge, game-changing, world-class, delve, unleash. Fenced code blocks and CHANGELOG.md are not read.
Why
Filler words are the most recognisable trace of generated prose and say nothing a reader can act on.
Check
For each item in:
grep("**/*.md", r'\b(seamless(ly)?|blazing(ly)?[- ]fast|cutting[- ]edge|state[- ]of[- ]the[- ]art|leverag(e|es|ed|ing)|effortless(ly)?|supercharg(e|es|ed|ing)|game[- ]chang(er|ing)|world[- ]class|delv(e|es|ing)|unleash(es|ed|ing)?)\b')item.path.endsWith("CHANGELOG.md")Fix
Rewrite the line to state the concrete behaviour; delete the adjective.
Agent instruction: Rewrite each flagged line without the flagged word, keeping the technical content; do not add new adjectives.
Sources
Generated by fleetlint docs from catalog v0.8.0.