-
-
Notifications
You must be signed in to change notification settings - Fork 69
chore: add exit code section #898
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.
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughUpdated two CLI reference markdown files: added "Exit codes" sections and small formatting tweaks. The two files document exit-status semantics that are inconsistent with each other (opposite return-code meanings for matches vs. no matches). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
website/reference/cli/run.md(1 hunks)website/reference/cli/scan.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
website/**/*.md
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
website/**/*.md: Documentation should use clear, concise language
Include code examples for concepts in documentation
Test documentation examples in the playground when possible
Maintain consistent formatting across documentation pages
Files:
website/reference/cli/run.mdwebsite/reference/cli/scan.md
🔇 Additional comments (1)
website/reference/cli/run.md (1)
202-202: Verify formatting consistency for help option text.The dash has been removed from the help option, converting it from a list item to plain text. Confirm this formatting aligns with the documentation style guide and is consistent with other help sections across the CLI reference documentation (particularly
website/reference/cli/scan.md, where the help text retains different formatting).
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.