Skip to content

Add blog post on deprecation of DeviceEntry.suggested_area #2740

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Aug 19, 2025
Merged

Add blog post on deprecation of DeviceEntry.suggested_area #2740

merged 5 commits into from
Aug 19, 2025

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Aug 1, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Add blog post on deprecation of DeviceEntry.suggested_area

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

Summary by CodeRabbit

  • Documentation
    • Added a blog post announcing deprecation and upcoming removal of the device suggested_area attribute and advising to use the device’s assigned area instead.
    • Updated device registry docs to remove suggested_area as a device property and to document the new device-info shape and expanded device creation/registration guidance.

@emontnemery emontnemery mentioned this pull request Aug 1, 2025
Merged
19 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 1, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

Added a blog post announcing deprecation and planned removal of DeviceEntry.suggested_area from events. Updated device registry documentation: removed suggested_area from the device properties table, introduced a DeviceInfo TypedDict, documented a device_info method on HueLight, and expanded DeviceRegistry.async_get_or_create signature and usage example.

Changes

Cohort / File(s) Change Summary
Deprecation Blog Post
blog/2025-08-01-suggested-area-removed-from-deviceentry.md		 Added post announcing deprecation/removal timeline for DeviceEntry.suggested_area, warns on access, advises use of DeviceEntry.area_id, and links PR/docs.
Device registry documentation
docs/device_registry_index.md		 Removed suggested_area row from device properties table; added DeviceInfo TypedDict; added device_info(self) -> DeviceInfo example; extended DeviceRegistry.async_get_or_create(...) -> DeviceEntry signature and usage example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 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.

📜 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

💡 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 57e8d54 and 57a70a9.

📒 Files selected for processing (1)
  • docs/device_registry_index.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
*/**(html|markdown|md)

⚙️ CodeRabbit Configuration File

*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

*/**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

  • Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

  • Use sentence-style capitalization also in headings.

do not comment on HTML used for icons

Avoid flagging inline HTML for embedding videos in future reviews for this repository.

Files:

  • docs/device_registry_index.md
⏰ 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 (2)
docs/device_registry_index.md (2)

109-143: Docs match core signature; no removal of parameters needed

The async_get_or_create signature in docs/device_registry_index.md exactly reflects the upstream implementation. The following kwargs are all present and accepted by the core API:

  • config_subentry_id
  • created_at
  • modified_at
  • translation_key
  • translation_placeholders

Dropping created_at and modified_at from the docs would desynchronize them from the actual code. Leave the documentation as is.

Likely an incorrect or invalid review comment.

58-82: Maintain created_at/modified_at in DeviceInfo docs
The DeviceInfo TypedDict in homeassistant/helpers/device_registry.py includes both created_at and modified_at. To stay in sync with the source of truth, these fields should remain in the documentation.

Likely an incorrect or invalid review comment.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch blog_remove_device_entry_suggested_area

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 or @coderabbitai title 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.

coderabbitai[bot]
coderabbitai bot reviewed Aug 1, 2025
View reviewed changes
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: 2

🧹 Nitpick comments (1)
blog/2025-08-01-suggested-area-removed-from-deviceentry.md (1)

13-13: Tighten cross-reference sentence

Use an imperative “See …” and drop filler words.

-For more details, refer to the [DeviceEntry documentation](/docs/device_registry_index#device-properties) and core [PR 149730](https://github.com/home-assistant/core/pull/149730) which deprecated `DeviceEntry.suggested_area`.
+See the [DeviceEntry documentation](/docs/device_registry_index#device-properties) and core [PR 149730](https://github.com/home-assistant/core/pull/149730) for details.
📜 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 0e3a7b7 and 24e95f9.

📒 Files selected for processing (2)
  • blog/2025-08-01-suggested-area-removed-from-deviceentry.md (1 hunks)
  • docs/device_registry_index.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/device_registry_index.md
🧰 Additional context used
📓 Path-based instructions (1)
*/**(html|markdown|md)

⚙️ CodeRabbit Configuration File

*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

*/**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

  • Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

  • Use sentence-style capitalization also in headings.

do not comment on HTML used for icons

Avoid flagging inline HTML for embedding videos in future reviews for this repository.

Files:

  • blog/2025-08-01-suggested-area-removed-from-deviceentry.md

MartinHjelmare
MartinHjelmare requested changes Aug 1, 2025
View reviewed changes
@home-assistant
Copy link

home-assistant bot commented Aug 1, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft August 1, 2025 13:28
@emontnemery emontnemery marked this pull request as ready for review August 19, 2025 07:28
MartinHjelmare
MartinHjelmare approved these changes Aug 19, 2025
View reviewed changes
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare MartinHjelmare merged commit da6574c into master Aug 19, 2025
5 checks passed
@MartinHjelmare MartinHjelmare deleted the blog_remove_device_entry_suggested_area branch August 19, 2025 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@MartinHjelmare MartinHjelmare MartinHjelmare approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@emontnemery @MartinHjelmare