markdown-html-comments
There are no HTML comments in review-ready EIPs.
Examples
error[markdown-html-comments]: HTML comments are not allowed when `status` is `Last Call` --> input.md | 16 | <!-- This is an html comment --> |
warning[markdown-html-comments]: HTML comments are only allowed while `status` is one of: `Draft`, `Withdrawn` --> input.md | 16 | <!-- This is an html comment --> |
Explanation
markdown-html-comments looks through
proposals for any HTML-style comments (i.e.
<!-- ... -->) and reports if it finds
any.
Final proposals should not contain any HTML comments because they are not visible after rendering. They are allowed in draft proposals (as warnings) to indicate incomplete sections and TODO items.