docs: clarify blank-line rule in admonition multi-line examples#3468
Conversation
Fix the Plain admonition example so it actually renders multiple lines, and spell out that paragraphs inside an admonition must be separated by a blank line. Co-authored-by: Cursor <cursoragent@cursor.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the admonitions documentation to clarify multi-line formatting support. A new tabbed "Multiple paragraphs" example is added under Basic admonitions to demonstrate handling of multi-paragraph content. The Plain admonition example is expanded by adding a sample content line ("This is a plain callout.") to both the rendered output and the corresponding Markdown code block, providing concrete demonstration of multi-line text in plain admonitions. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
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 |
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/syntax/admonitions.md`:
- Around line 7-8: The intro to the Admonitions doc is missing the explicit rule
that paragraphs inside an admonition must be separated by a blank line; update
the sentence immediately after "Admonitions can span multiple lines and support
inline formatting." to add a clear rule like "Separate paragraphs inside an
admonition with a blank line." so readers know to insert an empty line between
paragraphs; keep the wording concise and mirror the tone of the existing intro
so it reads as a single, authoritative rule.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 3cf6a341-f7d5-431c-9a88-fa014f479f94
📒 Files selected for processing (1)
docs/syntax/admonitions.md
…line-blank-line-3131
- Add an explicit multi-paragraph admonition example (Output + Markdown tabs) so the page demonstrates the blank-line paragraph behavior instead of only asserting it. - Keep the intro sentence simple per review (no redundant prose rule); remove trailing whitespace introduced earlier. Co-authored-by: Cursor <cursoragent@cursor.com>
Why
Closes #3131. The admonitions page claims callouts "can span multiple lines and support inline formatting," but the Plain example reproduced the exact misleading pattern that confused authors: its content reads "It can span multiple lines…" yet sits on a single line with no blank line, so it renders as one paragraph. The page also never stated the standard Markdown rule that adjacent lines collapse into one paragraph.
#3129 already corrected the Note example; this finishes the remaining gap.
What
Made with Cursor