Update configuration.md

[smb06]

Fixing a missed | to denote that path instructions must be an array of strings

Summary by CodeRabbit

• Documentation
  • Updated the formatting of the instructions field in the example YAML snippet for improved clarity.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	2b6a7b4
Status:	✅  Deploy successful!
Preview URL:	https://5fe38c44.coderabbit-docs.pages.dev
Branch Preview URL:	https://smb06-patch-1.coderabbit-docs.pages.dev

View logs

[coderabbitai]

📝 Walkthrough

Walkthrough

The update changes the formatting of the instructions field in a YAML example within the documentation. It switches from an array format to a multi-line string using the YAML literal block style, without altering the actual instructional content.

Changes

Cohort / File(s)	Change Summary
Documentation Example Update docs/reference/configuration.md	Reformatted the instructions field in the YAML example from an array to a multi-line string using the pipe (`

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A dash became a flowing stream,
In YAML's arms, instructions gleam.
From lists to blocks, the docs now sing,
With pipes and lines, a tidy thing.
So raise a toast to format's art—
Where clarity and style both play their part!

Pre-Merge Checks (1 passed, 2 warnings)

❌ Failed Checks (2 warnings)

Check Name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title 'Update configuration.md' is too generic and doesn’t convey the specific YAML formatting change being made.	Revise the title to clearly reflect the change, for example: 'Use YAML literal block for path instructions in configuration.md'.
Description Check	⚠️ Warning	The description is brief and lacks context such as the file path, detailed rationale, and any testing steps, and there is no template to guide consistency.	Expand the description to include a summary of changes, the affected file path, the reason for the update, and testing instructions, and consider adding a PR template for structured consistency.

✅ Passed Checks (1 passed)

Check Name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch smb06-patch-1

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests 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.