Skip to content

Clarify Fenced-Content Example in a Docstring #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ptr727 merged 2 commits into from
Aug 22, 2026
Merged

Clarify Fenced-Content Example in a Docstring #905

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a50ee6c
Clarify undeclared_h2_headings docstring's fenced-content example
ptr727 Aug 22, 2026
6a63885
Fix or/each grammatical mismatch in the docstring
ptr727 Aug 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions spec/audit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,8 +478,8 @@ def undeclared_h2_headings(text, declared):
then holds for any caller, regardless of how its own names are cased or spaced.
Scoped to `## ` only, the section model's unit. An H1 title or a nested H3 is not itself a
section this check judges.
Fence-aware via unfenced_text. A `## ` line inside a fenced code sample, or a `##`-prefixed
shell comment, is not misread as a real heading.
Fence-aware via unfenced_text. Either a heading-syntax line or a `##`-prefixed shell comment, shown
inside a fenced code sample, is not misread as a real heading.
"""
h2s = {ln[3:].strip().lower() for ln in unfenced_text(text).split("\n") if ln.startswith("## ")}
return sorted(h2s - {d.strip().lower() for d in declared})
Expand Down