fix: remove stray closing quote in quick-spec step-04-review.md#1434
fix: remove stray closing quote in quick-spec step-04-review.md#1434arcaven wants to merge 5 commits intobmad-code-org:mainfrom
Conversation
📝 WalkthroughWalkthroughRemoves a stray closing quotation mark from the Quick Summary template in the review step that was breaking markdown output formatting. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Address review feedback from @bmadcode - the opening quote on line 38 was left orphaned after removing the closing quote on line 42.
|
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. |
|
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. |
|
@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. |
|
i hit it with |
|
withdrawing, not up to my standard |
|
@arcaven for some hard to explain reasons, I actually love this PR, and how it ended up :) Thanks! |
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
What
Remove errant closing quote on line 42 of
step-04-review.mdthat 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
"from line 42:- {files_count} files to modify"→- {files_count} files to modify"**Quick Summary:**) now stands alone as a display marker, consistent with other display patterns in the fileTesting