-
-
Notifications
You must be signed in to change notification settings - Fork 2k
(minor) Update _index.md of Binary Sensor page #5297
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
Needed a '-' and a new line.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughA formatting adjustment was made in the binary sensor documentation: the publish_initial_state bullet in the Advanced options section was repositioned with spacing/indentation changes. Content remains unchanged, noting publish_initial_state as a deprecated alias for trigger_on_initial_state. No code, logic, or control flow modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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: 0
🧹 Nitpick comments (2)
content/components/binary_sensor/_index.md (2)
84-84
: Make deprecation explicit and concise.Consider aligning with a clearer deprecation phrasing.
Apply this diff:
- - **publish_initial_state** (*Optional*, boolean): A deprecated equivalent to `trigger_on_initial_state`. + - **publish_initial_state** (*Deprecated*, boolean): Use `trigger_on_initial_state`.
80-83
: Typo and cross-link to the action anchor.Minor polish: fix “excuted” → “executed” and link to the action for quicker navigation.
Apply this diff:
- state changes from `unknown` to a valid state. This applies to the first valid state set, and any valid state set after - a `binary_sensor.invalidate_state` action has been excuted. The default is `false`. + state changes from `unknown` to a valid state. This applies to the first valid state set, and any valid state set after + a [`binary_sensor.invalidate_state`](#binary_sensor-invalidate_state-action) action has been executed. The default is `false`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
content/components/binary_sensor/_index.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/binary_sensor/_index.md
🔇 Additional comments (1)
content/components/binary_sensor/_index.md (1)
83-84
: Good fix: bullet and spacing restore proper list rendering.The added blank line and leading dash correctly format the deprecated option as a bullet under “Advanced options.”
Document page needed a '-' and a new line.