Skip to content

Reject a Backtick in a Backtick-Fence Info String #904

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 1 commit into from
Aug 22, 2026
Merged

Reject a Backtick in a Backtick-Fence Info String #904

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 23 additions & 5 deletions spec/audit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,16 +394,18 @@ def _fence_step(line, marker, marker_len):

Fence matching follows CommonMark. A fence marker needs at most 3 leading spaces, more reads as
content, not a boundary. A closing fence needs the same character, a run at least as long as the
opener's, and nothing but whitespace after that run. A mismatched or shorter marker (a ~~~ example
inside a ``` block, a ``` inside a longer ````), or trailing text (an opening fence's language tag has
no closing counterpart), does not close it.
opener's, and nothing but whitespace after that run.
A mismatched or shorter marker does not close it, such as a ~~~ example inside a ``` block, or a
``` inside a longer ````. Trailing text does not close it either, since an opening fence's language
tag has no closing counterpart. A backtick fence's info string may not itself contain a backtick,
per CommonMark, so such an opener is not a boundary either.
Comment on lines +398 to +401

@qodo-code-review qodo-code-review Bot Aug 22, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remediation recommended

1. _fence_step docstring wraps sentences 📜 Skill insight ✧ Quality

The updated _fence_step() docstring wraps sentences across lines and also places multiple
sentences on a single line. This violates the requirement that multi-line comments/docstrings use
exactly one sentence per line without mid-sentence line wraps.
Agent Prompt 
## Issue description
The `_fence_step()` docstring is multi-line prose that wraps mid-sentence and combines multiple sentences on one line, which violates the comment-structure rule.

## Issue Context
This docstring was edited in this PR and now contains several sentences that are split across lines and/or share a line with another sentence.

## Fix Focus Areas
- spec/audit.py[395-401]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

"""
stripped = line.lstrip(" ")
indent = len(line) - len(stripped)
char = stripped[:1]
run = len(stripped) - len(stripped.lstrip(char)) if indent <= 3 and char in ("`", "~") else 0
if marker is None:
if run >= 3:
if run >= 3 and not (char == "`" and "`" in stripped[run:]):
return char, run, True
return None, 0, False
if char == marker and run >= marker_len and not stripped[run:].strip():
Expand All @@ -419,7 +421,7 @@ def extract_section(text, heading):
marker-gap whitespace is still found rather than read as a missing section - internal heading-text
whitespace must match exactly. The heading line's exact bytes are then part of the hashed region, so that
re-casing or re-spacing surfaces as drift. A nested `###` stays inside the body. A `## ` line inside a
fenced code block, per `_fence_step`, is not a boundary, so a code sample cannot truncate the region and
fenced code block, per `_fence_step`, is not a boundary. So a code sample cannot truncate the region and
hide drift after it.
"""
want = heading.strip().lower()
Expand Down Expand Up @@ -2958,6 +2960,12 @@ def _selftest():
{"fleet bootstrap"},
[],
),
(
"a backtick in a backtick-fence info string is not a valid opener, so the heading after it is real",
"# AGENTS\n\n## Fleet Bootstrap\n\n```md`\n## Local Notes\n",
{"fleet bootstrap"},
["local notes"],
),
(
"a repo's own local content, undeclared, is flagged even in a file with its own declared sections",
(
Expand Down Expand Up @@ -3022,6 +3030,16 @@ def _selftest():
" ```\n## Real\n",
" ```\n## Real\n",
),
(
"a backtick in a backtick-fence info string is not a valid opener",
"```md`\n## Real\n",
"```md`\n## Real\n",
),
(
"a backtick in a tilde-fence info string does not disqualify it",
"~~~md`\n## Phantom\n~~~\n## Real\n",
"## Real\n",
),
]
uf_ok = True
for label, doc, want in uf:
Expand Down