-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Fix inconsistencies between documentation and code. #5695
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: current
Are you sure you want to change the base?
Conversation
Update rf_bridge references to my_rf_bridge. Compiler complains: ID 'rf_bridge' conflicts with the name of an esphome integration, please use another ID name. send_advanced_code() expects struct RFBridgeAdvancedData, not three individual parameters.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughDocumentation example code for the RF Bridge component updated to reference a consistent ID. Multiple action examples changed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/components/rf_bridge.md(8 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/rf_bridge.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: esphome/esphome-docs PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-24T00:13:13.459Z
Learning: Open pull requests against the correct base branch: use `current` for documentation-only revisions and `next` for changes tied to new features in esphome/esphome
Learnt from: jesserockz
Repo: esphome/esphome-docs PR: 4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build
🔇 Additional comments (1)
content/components/rf_bridge.md (1)
94-94: Consistent ID rename across all lambda examples.All references to
id(rf_bridge)have been systematically updated toid(my_rf_bridge)across the send_code, beep, learn, send_raw, start_advanced_sniffing, stop_advanced_sniffing, and start_bucket_sniffing action examples. This avoids the documented compiler conflict and makes the examples internally consistent.Also applies to: 119-119, 143-143, 173-173, 252-252, 275-275, 307-307
Update
rf_bridgereferences in lambdas tomy_rf_bridge. Compiler complains:ID 'rf_bridge' conflicts with the name of an esphome integration, please use another ID name.send_advanced_code()expectsstruct RFBridgeAdvancedData, not three individual parameters.Checklist:
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.