Rule Source
This rule comes from: https://github.com/mesosphere/dcos-docs-site
Rule Definition
extends: existence
message: "'%s' left in text."
ignorecase: false
level: error
tokens:
- XXX
- FIXME
- TODO
Development Comment Checker
Description
This rule scans for common development-specific comments or markers that are often left in text during the writing or review process. It's designed to catch placeholder text or reminder comments that shouldn't make it into the final documentation. These markers (like TODO or FIXME) are commonly used during content development but should be resolved before publication. Leaving such comments in published documentation appears unprofessional and can confuse readers.
Examples
This rule will flag:
- "XXX" markers (often used as placeholders)
- "FIXME" comments (indicating something needs to be fixed)
- "TODO" notes (indicating incomplete work)
For example:
❌ "TODO: Add more examples to this section"
❌ "FIXME: Check if this information is still current"
❌ "XXX update this paragraph"
The rule is case-sensitive, so only exact matches of "XXX", "FIXME", and "TODO" will be flagged. Lower-case versions of these markers will not trigger the rule.