Skip to content

Ignore README headings inside code blocks - #9

Merged
omerbek merged 1 commit into
mainfrom
fix/readme-code-block-headings
Aug 16, 2026
Merged

Ignore README headings inside code blocks#9
omerbek merged 1 commit into
mainfrom
fix/readme-code-block-headings

Conversation

@omerbek

@omerbek omerbek commented Aug 16, 2026

Copy link
Copy Markdown
Owner

What changed

  • Skip ATX-style heading detection while inside fenced Markdown code blocks.
  • Add regression tests for heading-like comments inside code blocks and real headings around code blocks.

Why

A README code example containing lines like # Usage should not satisfy the required Usage heading check.

Fixes #6

Validation

  • python -m unittest discover

@omerbek
omerbek merged commit bd1bcae into main Aug 16, 2026
2 checks passed
@omerbek
omerbek deleted the fix/readme-code-block-headings branch August 16, 2026 09:06
@omerbek omerbek mentioned this pull request Aug 16, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Avoid treating Markdown code block comments as README headings

1 participant