docs: better explain where to take the benchmark names from

[johanneskoester]

Summary by CodeRabbit

• Documentation
  • Improved the description for the benchmark field to clarify available benchmark sources and provide a helpful reference link for users.

[coderabbitai]

Walkthrough

The comment for the benchmark field under variant-calls in the configuration file was expanded to provide a more comprehensive explanation, including a reference URL for predefined benchmarks and a note about custom benchmarks. No configuration keys or values were changed.

Changes

File(s)	Change Summary
config/config.yaml	Expanded the comment for the benchmark field to clarify sources for benchmark names and presets.

Poem

A comment grew, with words anew,
To guide you where the benchmarks dwell—
Presets online, or custom too,
The YAML now explains it well.
🐰✨

---

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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

config/config.yaml (2)

19-21: Consistent capitalization in comments
The surrounding comments start with an uppercase letter. For consistency, update these lines to capitalize the first word.

-    # benchmark to use
-    # see benchmarks in https://github.com/snakemake-workflows/dna-seq-benchmark/blob/main/workflow/resources/presets.yaml
-    # or any custom benchmark name provided below under custom-benchmarks
+    # Benchmark to use
+    # See benchmarks in https://github.com/snakemake-workflows/dna-seq-benchmark/blob/main/workflow/resources/presets.yaml
+    # Or any custom benchmark name provided below under `custom-benchmarks`

---

20-20: Consider pinning or raw-linking the presets URL
Linking to the HTML view can change; using a raw file URL or referencing a specific commit/tag makes this more stable.

-    # See benchmarks in https://github.com/snakemake-workflows/dna-seq-benchmark/blob/main/workflow/resources/presets.yaml
+    # See benchmarks in https://raw.githubusercontent.com/snakemake-workflows/dna-seq-benchmark/main/workflow/resources/presets.yaml

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7d9f0e and 5295772.

📒 Files selected for processing (1)

• config/config.yaml (1 hunks)

🔇 Additional comments (1)

config/config.yaml (1)

22-22: ```shell
#!/bin/bash

Search for the benchmark key anywhere in the presets file (case-sensitive)

curl -s https://raw.githubusercontent.com/snakemake-workflows/dna-seq-benchmark/main/workflow/resources/presets.yaml
| grep -n 'giab-na12878-exome'

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->