Skip to content

Conversation

@Dsaquel
Copy link

@Dsaquel Dsaquel commented Dec 14, 2025

Summary by CodeRabbit

  • Documentation
    • CLI help text tidy-up: minor formatting fix to the help output wording for the run command.
    • Added "Exit codes" sections for run and scan commands explaining returned status:
      • run: exits 0 when at least one line matches, 1 when no match.
      • scan: exits 1 when at least one rule matches, 0 when no rules match.
    • Small spacing improvement in the scan help block for clearer readability.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 14, 2025

Walkthrough

Updated 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

Cohort / File(s) Summary
run.md (CLI reference)
website/reference/cli/run.md
Added an "Exit codes" section describing exit status semantics (0 when at least one line matches, 1 when no match). Removed a leading dash from the "Print help" line (formatting).
scan.md (CLI reference)
website/reference/cli/scan.md
Added an "Exit codes" subsection (describes exit status semantics as 1 when at least one rule matches, 0 when no rules match). Inserted an extra blank line after the help line (formatting).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify consistency between run.md and scan.md exit-code semantics (they currently conflict).
  • Confirm formatting adjustments render properly in generated site (lists/blank lines).
  • No code changes present.

Poem

🐰 In docs I hop and softly write,
Exit codes danced into the night,
One says zero when matches play,
The other flips — a puzzled fray.
I nibble notes and mend the light.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding exit code documentation sections to CLI reference files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ee646b5 and 5c0ef2f.

📒 Files selected for processing (2)
  • website/reference/cli/run.md (1 hunks)
  • website/reference/cli/scan.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • website/reference/cli/scan.md
  • website/reference/cli/run.md

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.

Copy link

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 45b76ba and ee646b5.

📒 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.md
  • website/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).

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.

1 participant