Skip to content

docrot-scan-api v1.2.0 — exclude code examples from live checks

Choose a tag to compare

View all tags
@auroraxo auroraxo released this 28 Sep 11:10
· 12 commits to main since this release
v1.2.0
afc062e

v1.2.0 — Code examples are no longer live-checked

Fix: URLs inside fenced code blocks (``` / ~~~) and inline code spans of Markdown/MDX files are excluded from the liveness check — example syntax is not rendered, so checking it produced false "broken" verdicts in customer reports. Same false-positive class as the v1.1.0 entity-decode fix; mirrors the open-source scanner's strip_code behavior.

Design notes:

  • Line-based fence walker blanks every content line to an empty line, so reported line-number provenance stays exact.
  • Per CommonMark, an unclosed fence extends to end of document.
  • extract_rst untouched — backticks are ordinary link syntax in reStructuredText.

Verification: 6 new regression tests (fence, tilde fence, unclosed fence, inline span, line-number provenance, RST-untouched) — suite 108 → 114 green.

Dogfood: the paid API's first post-fix self-scan of auroraxo/docrot reports zero broken links with the code-heavy README now scanned correctly.

Assets 2
Loading