Skip to content

docrot-scan-api v1.3.0 — exclude RST literals and HTML comments from checks

Choose a tag to compare

View all tags
@auroraxo auroraxo released this 28 Sep 12:43
· 9 commits to main since this release
v1.3.0
2184226

v1.3.0 — RST literal blocks and HTML comments are no longer live-checked

Fix: third instance of the same false-positive class:

  • reStructuredText: URLs inside literal blocks — paragraphs ending in :: and .. code-block:: / .. sourcecode:: directives — are no longer live-checked. Rendered directives (.. note::, .. seealso::) keep their links, and argument-carrying lines (.. image:: x.png) never trigger blanking.
  • HTML comments: href/src inside <!-- ... --> are no longer live-checked in Markdown/MDX, RST, and HTML files.

Both strippers are line-based with exact newline preservation, so line-number provenance stays exact. A screenshot's comment-stripped HTML paragraph is reported on its true line.

Known limitations (deliberate): indented (4-space) Markdown code blocks and RST comment bodies remain checked — telling them apart from list continuation lines / arbitrary directives needs a full parser, and false negatives are the worse failure for a paid check. Documented in docs/API.md.

Verification: 5 new regression tests — suite 114 → 119 green.

Context: v1.1.0 (entity decode) → v1.2.0 (fenced/inline code) → v1.3.0 (RST literals, HTML comments) — same defect family, found by the scanner↔API parity check that is now a fixed producer-pulse ritual.

Assets 2
Loading