docs: fix comment

[posva]

Summary by CodeRabbit

• Documentation
  • Updated internal comments to clearly differentiate between configuration files and their corresponding tests, enhancing overall clarity.

[coderabbitai]

Walkthrough

The pull request updates comments in two YAML configuration files to clarify their intended roles. In the file for the rule configuration, the comment is changed from indicating a test file to labeling it as a rule file. Conversely, the corresponding test file now correctly indicates its purpose by switching its comment from “rule file” to “test file”. These adjustments remove ambiguity about file roles in the project’s directory structure.

Changes

File(s)	Change Summary
my-awesome-rules/rules/no-await-in-loop.yml my-awesome-rules/rule-tests/no-await-in-loop-test.yml	Updated comments to clarify file roles: changed from “# test file” to “# rule file” in the rules file and from “# rule file” to “# test file” in the test file.

Poem

I'm a bunny with a hop of cheer,
Code comments now clear for all to hear,
A twist of rules and tests in line,
Each file now speaks its role just fine,
Hopping through code with joy sincere!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 7855ad3 and 53e00f8.

📒 Files selected for processing (1)

• website/guide/test-rule.md (1 hunks)

🔇 Additional comments (2)

website/guide/test-rule.md (2)

43-43: Updated Comment for Rule File

The comment for no-await-in-loop.yml is now correctly marked as a "rule file". This change clearly indicates its purpose in the rules directory and removes any ambiguity regarding its role.

---

45-45: Updated Comment for Test File

The comment for no-await-in-loop-test.yml has been updated to "test file", which accurately reflects its role in storing test cases for the rule. This clarification improves the documentation clarity.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• 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 generate docstrings to generate docstrings for this 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 the configuration 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 our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[HerringtonDarkholme]

thanks