This repository was archived by the owner on Aug 16, 2025. It is now read-only.

coderabbitai/coderabbit-docsPublic archive

NotificationsYou must be signed in to change notification settings
Fork69
Star116

added ignore command in the doc#131

Merged

dikshant-coderabbit merged 1 commit intomainfromupdate-commands

Nov 4, 2024

Merged

added ignore command in the doc#131

dikshant-coderabbit merged 1 commit intomainfromupdate-commands

Nov 4, 2024

Conversation

Copy link

Collaborator

dikshant-coderabbit commentedNov 4, 2024

No description provided.

added ignore command in the doc

45edc4f

dikshant-coderabbit requested a review fromaravindputrevu

November 4, 2024 15:51

Copy link

Contributor

coderabbitaibot commentedNov 4, 2024•
edited
Loading

Walkthrough

The documentation for CodeRabbit commands has been updated to include a new command,@coderabbitai ignore, which allows users to ignore reviews on a pull request (PR). This addition expands the functionality available to users while maintaining the existing structure and content of the documentation.

Changes

File	Change Summary
docs/guides/commands.md	Added new command`@coderabbitai ignore` to ignore PR reviews.

Poem

In the land of CodeRabbit, so bright and so clear,
A new command hops in, bringing cheer!
With@coderabbitai ignore, reviews can be tossed,
A little less worry, no need to feel lost.
So let's celebrate changes, with a leap and a bound,
In the garden of code, joy and fun can be found! 🐇✨

🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag@coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag@coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add@coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add@coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add@coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a.coderabbit.yaml file to the root of your repository.
Please see theconfiguration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit ourDocumentation for detailed information on how to use CodeRabbit.
Join ourDiscord Community to get help, request features, and share feedback.
Follow us onX/Twitter for updates and announcements.

Copy link

cloudflare-workers-and-pagesbot commentedNov 4, 2024

Deploying coderabbit-docs with Cloudflare Pages

Latest commit:	`45edc4f`
Status:	✅ Deploy successful!
Preview URL:	https://cc85c369.coderabbit-docs.pages.dev
Branch Preview URL:	https://update-commands.coderabbit-docs.pages.dev

View logs

aravindputrevu approved these changes

Nov 4, 2024

View reviewed changes

Copy link

CollaboratorAuthor

dikshant-coderabbit commentedNov 4, 2024

@coderabbitai resolve

coderabbitaibot reviewed

Nov 4, 2024

View reviewed changes

Copy link

Contributor

coderabbitaibot 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: 0

🧹 Outside diff range and nitpick comments (1)

docs/guides/commands.md (1)
14-14:Consider improving organization and style.
The command list would be more user-friendly with these improvements:
Group related commands together (e.g., review control commands likepause,resume,ignore in one section)
Add section headers for different command categories
Consider alphabetical ordering within each category
Also, to avoid repetitive sentence beginnings flagged by the style checker, consider varying the command descriptions:
-  - `@coderabbitai ignore` to ignore the reviews on a PR.+  - `@coderabbitai ignore` prevents any further reviews on the PR.
🧰 Tools
🪛 LanguageTool
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aused reviews. -@coderabbitai ignore to ignore the reviews on a PR. - `@coderab...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between42a66a2 and45edc4f.

📒 Files selected for processing (1)

docs/guides/commands.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/guides/commands.md

[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aused reviews. -@coderabbitai ignore to ignore the reviews on a PR. - `@coderab...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (1)

docs/guides/commands.md (1)

14-14:🛠️ Refactor suggestion

Please clarify the behavior of theignore command.

The documentation should provide more details about:

Whether ignoring reviews is permanent or temporary
How this differs from thepause command
How to "unignore" reviews if needed
What happens to existing reviews when this command is used

Consider expanding the documentation like this:

-  - `@coderabbitai ignore` to ignore the reviews on a PR.+  - `@coderabbitai ignore` to permanently disable CodeRabbit reviews on this PR.+    This differs from `pause` as it cannot be reversed. Existing reviews will remain+    but no new reviews will be generated.

🧰 Tools

🪛 LanguageTool

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)