Skip to content

Conversation

@mik-laj
Copy link
Contributor

@mik-laj mik-laj commented Oct 21, 2025

Proposed change

RemoteEntity extends ToggleEntity, so it also inherit is_on property.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Updated Remote entity docs: added an is_on (boolean) property with description and default, reordered and clarified activity-related entries, and improved the properties table layout for clearer reading.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025

📝 Walkthrough

Walkthrough

Updated the Remote entity documentation table: adjusted header formatting, added a new is_on boolean property (default None), and reordered/updated current_activity and activity_list rows. No code or behavioral changes.

Changes

Cohort / File(s) Summary
Documentation Update
docs/core/entity/remote.md
Reformatted the properties table header, added an is_on boolean property row (default None), and reordered/updated current_activity and activity_list rows; documentation-only edits.

Sequence Diagram(s)

No sequence diagrams — documentation-only change.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description is incomplete in several critical areas of the required template. The "Type of change" section has no checkbox selected, which is explicitly required by the template with the note to "check only 1 box." The "Checklist" section is entirely unchecked, meaning the author has not confirmed following documentation guidelines or verifying that changes render correctly. The "Proposed change" section is present but minimal, and the "Additional information" section lacks the requested links to relevant code or related pull requests. These omissions represent core parts of the template that are empty.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (1 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Add missing is_on property to RemoteEntity" is concise, specific, and directly reflects the main change in the documentation. The title clearly communicates that the PR is adding or documenting the is_on property for RemoteEntity, which aligns with the raw summary showing a new is_on column added to the entity's properties table. The title is descriptive enough for someone reviewing the repository history to understand the primary intent without ambiguity.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 8cf2780 and 0e1bd36.

📒 Files selected for processing (1)
  • docs/core/entity/remote.md (1 hunks)
🔇 Additional comments (1)
docs/core/entity/remote.md (1)

19-23: Documentation accurately reflects RemoteEntity inheritance.

The properties table correctly documents the is_on property inherited from ToggleEntity. The formatting is clean, type annotations are appropriate, and default values are correctly set. The changes incorporate previous feedback and maintain consistency with markdown table standards.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

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 (1)
docs/core/entity/remote.md (1)

19-21: Minor formatting inconsistency: Default value representation.

Line 21 uses backticks around None to format it as code, but the existing default values on lines 22-23 are not backticked. For consistency, consider aligning the formatting across all rows.

Apply this diff to standardize the formatting:

- | is_on | boolean | `None` | If the device is currently on or off. |
- | current_activity | str | None | Return the list of available activities |
- | activity_list | list | None | Return the list of available activities |
+ | is_on | boolean | None | If the device is currently on or off. |
+ | current_activity | str | None | Return the current active activity |
+ | activity_list | list | None | Return the list of available activities |

(Note: I also aligned the description for current_activity which appears to have been incorrectly copied from activity_list.)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 39bb544 and da5a04c.

📒 Files selected for processing (1)
  • docs/core/entity/remote.md (1 hunks)
⏰ 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). (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant
🔇 Additional comments (1)
docs/core/entity/remote.md (1)

19-21: Documentation addition looks good.

The change correctly documents the is_on property as an inherited member from ToggleEntity. The property type, default, and description are accurate and align with the PR objectives.

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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between da5a04c and 8cf2780.

📒 Files selected for processing (1)
  • docs/core/entity/remote.md (1 hunks)

abmantis
abmantis previously approved these changes Oct 24, 2025
Copy link
Member

@abmantis abmantis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@abmantis abmantis merged commit 3bfd684 into home-assistant:master Oct 24, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants