Skip to content

fix: remove stray closing quote in quick-spec step-04-review.md#1434

Closed
arcaven wants to merge 5 commits intobmad-code-org:mainfrom
arcaven:fix/stray-quote-step-04-review
Closed

fix: remove stray closing quote in quick-spec step-04-review.md#1434
arcaven wants to merge 5 commits intobmad-code-org:mainfrom
arcaven:fix/stray-quote-step-04-review

Conversation

@arcaven
Copy link
Copy Markdown
Contributor

@arcaven arcaven commented Jan 28, 2026

What

Remove errant closing quote on line 42 of step-04-review.md that creates malformed markdown output in the Quick Summary display block.

Why

The trailing " on line 42 doesn't properly close the multi-line quoted block and appears literally in workflow output, creating inconsistent formatting.

Fixes #1433

How

  • Removed the trailing " from line 42: - {files_count} files to modify"- {files_count} files to modify
  • The opening quote on line 38 ("**Quick Summary:**) now stands alone as a display marker, consistent with other display patterns in the file

Testing

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

Removes a stray closing quotation mark from the Quick Summary template in the review step that was breaking markdown output formatting.

Changes

Cohort / File(s) Change Summary
Template text correction
src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md
Removes trailing " from line 42 (- {files_count} files to modify"- {files_count} files to modify) to fix malformed markdown output in Quick Summary.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • pbean
  • muratkeremozcan
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing a stray closing quote from step-04-review.md that was causing formatting issues.
Description check ✅ Passed The description clearly relates to the changeset, explaining what was changed, why it was necessary, and how it was fixed.
Linked Issues check ✅ Passed The pull request directly addresses issue #1433 by removing the errant closing quote on line 42, matching the exact fix specified in the linked issue.
Out of Scope Changes check ✅ Passed The change is narrowly scoped to fixing the specific issue: removing a single trailing quote character from one line in the specified file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@bmadcode
Copy link
Copy Markdown
Collaborator

There is an opening quote than that should also be removed on line 38 @arcaven - or better yet we should not hard code exaclt output and instead give the model the intent for output. cc @alexeyv

Address review feedback from @bmadcode - the opening quote on line 38
was left orphaned after removing the closing quote on line 42.
@arcaven
Copy link
Copy Markdown
Contributor Author

arcaven commented Jan 28, 2026

Thanks @bmadcode - good catch! I've pushed a follow-up commit to remove the orphaned opening quote on line 38 as well. Both quotes are now removed, so the Quick Summary displays as regular markdown without the enclosing quotes.

@arcaven
Copy link
Copy Markdown
Contributor Author

arcaven commented Jan 28, 2026

I suppose it's more of a problem for my linters and isn't an actual bug now that I see the full context. In any case, it seems like a completely optional set of quotes, with little upside, and the potential for more reports. But I'm not at all offended with a declined PR. Thanks for sharing your hard work with BMAD.

@alexeyv
Copy link
Copy Markdown
Collaborator

alexeyv commented Jan 28, 2026

@arcaven Before I know what to do with this, I'd like to understand exactly what does this look like in your session, and what LLM/platform are we talking. That pair of double quotes is supposed to mark the beginning and end of the output template. Is it getting into the output?

@arcaven
Copy link
Copy Markdown
Contributor Author

arcaven commented Jan 28, 2026

@arcaven Before I know what to do with this, I'd like to understand exactly what does this look like in your session, and what LLM/platform are we talking. That pair of double quotes is supposed to mark the beginning and end of the output template. Is it getting into the output?

It parses fine as-is for LLM and in session, it is strictly a linter and LLM code review trap, false half-quote. I suggest the trap is not needed, entirely optional, as with and without quotes is semantically similar, but i’m not attached to this topic, I wouldn’t open it now if i understood it as I do now.

@alexeyv
Copy link
Copy Markdown
Collaborator

alexeyv commented Jan 28, 2026

It parses fine as-is for LLM and in session, it is strictly a linter and LLM code review trap, false half-quote.
Gotcha. Stuff like this is borderline worth fixing because linter noise is bad. Is that Markdown linter or what kind of linter?

@arcaven
Copy link
Copy Markdown
Contributor Author

arcaven commented Jan 28, 2026

It parses fine as-is for LLM and in session, it is strictly a linter and LLM code review trap, false half-quote.
Gotcha. Stuff like this is borderline worth fixing because linter noise is bad. Is that Markdown linter or what kind of linter?

i hit it with yamllint vs code yaml lint extension (shouldn't be highlighting in markdown anyways!) a qudo review using openai keys in our copy of the generated checked out versions, and my own dumb eyeballs and human context window failing to scroll back sufficiently to see the opening quote while being excited about the other issues I was overexcited to offer PRs about. My apologies. Then I realized: if i hit it someone else might, and, asked myself why bother with the multi-line quote? it’s not sprintf. It’s an LLM, save the bytes! it gets the intent both ways. shorter is better? happy to close the report, it’s false but well intended.

@arcaven
Copy link
Copy Markdown
Contributor Author

arcaven commented Jan 28, 2026

withdrawing, not up to my standard

@arcaven arcaven closed this Jan 28, 2026
@alexeyv
Copy link
Copy Markdown
Collaborator

alexeyv commented Jan 29, 2026

@arcaven for some hard to explain reasons, I actually love this PR, and how it ended up :) Thanks!

alexeyv added a commit to alexeyv/BMAD-METHOD that referenced this pull request Jan 29, 2026
Double-quote delimiters around multi-line output template blocks are
visually ambiguous to humans (opening quote on one line, closing quote
many lines later) and confuse linters and LLM code reviewers into
filing false issues (see bmad-code-org#1434).

A/B tested across 5 models (Opus, Sonnet, Haiku, Codex 5.2, Gemini):
removing quotes entirely causes Haiku to refuse instructions in 1/3
runs, but any explicit block delimiter works equally well. XML-style
output-block tags are the best fit: visually obvious boundaries,
self-documenting, linter-clean, and consistent with existing BMAD
XML tag conventions (step, action, check, template-output).

Relates to bmad-code-org#1433
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.

[Bug] Stray closing quote in step-04-review.md breaks Quick Summary template

3 participants