[shenxianpeng]

Summary

Docs/code consistency pass of the v2 docs against the clap definitions and current behavior.

docs/cli.yml (version and permission badges, looked up by each option's long name):

• extra-args never matched: the option is --extra-arg. Renamed the key.
• tidy-review / format-review are now only aliases of --pr-review (deprecate: replace --tidy-review/--format-review with --pr-review #377), so --pr-review had no version or permission badge. Replaced both with a pr-review entry (pull-requests: write).
• --mod-sys / --no-mod-sys had no entries; added them.

docs/docs/pr-review-caveats.md:

• The collapsed patch in the review summary only holds the suggestions that did not fit in the diff (common_fs.rs), and it is left out when it is too large for a comment (clang_tools/mod.rs). The docs said the full patch is always included.
• Added that suggestions already posted in an earlier review are not repeated, and no new review is posted when all of them were (rest_client.rs).

Related Issues

None.

Summary by CodeRabbit

• Documentation
  • Updated CLI guidance for system-module options and the singular extra-arg setting.
  • Consolidated pull-request review configuration under pr-review, replacing the separate tidy and format review entries.
  • Clarified that previously posted suggestions aren’t repeated and that no new review is posted when all suggestions have already been shared.
  • Updated guidance for suggestions outside the pull-request diff: the summary comment includes a collapsible patch when it fits.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository UI (base), Organization UI (inherited)
• Review profile: CHILL
• Plan: Advanced
• Run ID: 84c4da6e-136e-4506-bcc2-5ae9ff3974a7

📥 Commits

Reviewing files that changed from the base of the PR and between 1bce8f1 and af9b223.

📒 Files selected for processing: 2

• docs/cli.yml
• docs/docs/pr-review-caveats.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The CLI documentation adds and renames options. The PR review caveats now describe repeated suggestions and patch inclusion limits.

Changes: CLI and PR review documentation

Layer / File(s)	Summary
CLI option declarations docs/cli.yml	The CLI reference adds mod-sys and no-mod-sys, renames extra-args to extra-arg, and replaces tidy-review and format-review with pr-review.
PR review caveats docs/docs/pr-review-caveats.md	The caveats state that previously posted suggestions are not repeated, and that no new review is posted when all suggestions were already posted. They also state that a patch may be omitted from the review summary comment if it is too large to fit.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Merge Risk: ⚪ Minimal · up to af9b2

The CLI reference and PR review caveats match the current behavior. No actionable merge risk remains.

Pre-merge checks: 5

Check name	Status	Explanation
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the documentation updates to CLI option metadata and pull request review caveats. These changes match the main changeset.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}