docs: clarify dependencies section is for tool dependencies only#2045
docs: clarify dependencies section is for tool dependencies only#2045
Conversation
The dependencies section currently only supports tool version requirements. Component dependencies should use settings.depends_on instead. Added an admonition directing users to the correct documentation and noting that consolidation is planned. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
📝 WalkthroughWalkthroughThe dependencies documentation page is refocused to emphasize tool dependencies only. Component dependency content is removed and replaced with a tip directing users to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2045 +/- ##
=======================================
Coverage 75.63% 75.63%
=======================================
Files 793 793
Lines 73888 73888
=======================================
Hits 55883 55883
+ Misses 14517 14516 -1
- Partials 3488 3489 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
These changes were released in v1.205.1-rc.2. |
what
dependenciessection currently supports tool version requirements onlysettings.depends_onfor component execution ordersettings.depends_ondocumentationwhy
The documentation previously conflated two separate concepts: tool dependencies (currently implemented via
/dependencies/tools) and component dependencies (only available viasettings.depends_on). The examples showing component dependency syntax were misleading since they're not yet supported in the/dependenciessection. This change prevents user confusion and guides them to the correct feature.references
This fixes documentation confusion around component dependencies vs tool dependencies. The plan is to consolidate these features in a future release, so this admonition acknowledges that intent.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.