Skip to content

Conversation

PaulSchulz
Copy link
Contributor

Document page needed a '-' and a new line.

@esphome esphome bot added the current label Aug 27, 2025
Copy link

netlify bot commented Aug 27, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 0d682ad
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68aeb905ef1f810008210dc7
😎 Deploy Preview https://deploy-preview-5297--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Aug 27, 2025

Walkthrough

A 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

Cohort / File(s) Summary
Docs formatting
content/components/binary_sensor/_index.md
Adjusted bullet positioning, added blank line, and tweaked indentation in Advanced options; textual content unchanged; maintains note that publish_initial_state is a deprecated alias of trigger_on_initial_state.

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
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

📥 Commits

Reviewing files that changed from the base of the PR and between bdf8489 and 0d682ad.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant