Improve the description of the state field of Template Lock #39784

nadimz · 2025-06-30T20:01:55Z

Proposed change

Improve the description of the state field of template lock, listing the supported states and what happens when an unsupported state is return by the template.

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Add support for opening state in template lock

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Expanded and clarified the documentation for lock template entity states, listing all valid output values and their synonyms.
- Corrected minor whitespace in the vacuum entity's attribute templates section.

netlify · 2025-06-30T20:02:34Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`72f13b3`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/6864cc6ca4de8e000832cbbe
😎 Deploy Preview	https://deploy-preview-39784--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coderabbitai · 2025-06-30T20:04:02Z

📝 Walkthrough

Walkthrough

The documentation for the template lock entity was updated to explicitly list all valid output values for its state, clarify synonyms for locked and unlocked states, and specify the default behavior for unsupported states. Additionally, a minor whitespace correction was made in the vacuum entity's attribute templates section. No code or logic changes were introduced.

Changes

File(s)	Change Summary
source/_integrations/template.markdown	Expanded and clarified documentation for template lock state values; minor whitespace cleanup in vacuum attribute section.

Sequence Diagram(s)

No sequence diagram is provided as the changes are limited to documentation updates without any control flow or feature modifications.

📜 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 2a9e894 and 72f13b3.

📒 Files selected for processing (1)

source/_integrations/template.markdown (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/template.markdown

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

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.
- Explain this complex logic.
- 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. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
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 src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

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

Documentation and Community

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

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/template.markdown (1)
1449-1451: Clarify whether true/false synonyms are case-insensitive

Elsewhere in the doc (e.g. availability) you explicitly state that string comparisons aren’t case-sensitive. Adding a similar note here would eliminate any doubt:
… In addition, `true` and `on` (case-insensitive) are valid …
This keeps behaviour documentation consistent across sections.

📜 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 adf7251 and 68a77c6.

📒 Files selected for processing (1)

source/_integrations/template.markdown (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (1)

source/_integrations/template.markdown (1)

3470-3475: Whitespace-only tweak LGTM
No functional content affected.

source/_integrations/template.markdown

Petro31

LGTM

source/_integrations/template.markdown

c0ffeeca7

Thank you, @nadimz and @Petro31 👍

Improve description for the state field of template lock

68a77c6

nadimz requested a review from a team as a code owner June 30, 2025 20:01

home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Jun 30, 2025

nadimz mentioned this pull request Jun 30, 2025

Add support for opening state in template lock home-assistant/core#147813

Merged

19 tasks

coderabbitai bot reviewed Jun 30, 2025

View reviewed changes

Petro31 reviewed Jun 30, 2025

View reviewed changes

source/_integrations/template.markdown Outdated Show resolved Hide resolved

home-assistant bot closed this Jul 1, 2025

home-assistant bot reopened this Jul 1, 2025

nadimz and others added 2 commits July 1, 2025 16:09

Cleanup state variable description of template lock

2a9e894

Merge branch 'next' into template_lock

c3851e0

nadimz requested a review from Petro31 July 1, 2025 16:00

Petro31 approved these changes Jul 1, 2025

View reviewed changes

home-assistant bot added the parent-merged The parent PR has been merged already label Jul 1, 2025

c0ffeeca7 reviewed Jul 2, 2025

View reviewed changes

source/_integrations/template.markdown Outdated Show resolved Hide resolved

tiny tweak

72f13b3

c0ffeeca7 approved these changes Jul 2, 2025

View reviewed changes

c0ffeeca7 enabled auto-merge (squash) July 2, 2025 06:07

c0ffeeca7 disabled auto-merge July 2, 2025 12:10

c0ffeeca7 merged commit b2ed9d7 into home-assistant:next Jul 2, 2025
7 checks passed

home-assistant bot removed the parent-merged The parent PR has been merged already label Jul 2, 2025

nadimz deleted the template_lock branch July 2, 2025 13:06

github-actions bot locked and limited conversation to collaborators Jul 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Improve the description of the state field of Template Lock #39784

Improve the description of the state field of Template Lock #39784

nadimz commented Jun 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Jun 30, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 30, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Petro31 left a comment

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Improve the description of the state field of Template Lock #39784

Improve the description of the state field of Template Lock #39784

Conversation

nadimz commented Jun 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Petro31 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nadimz commented Jun 30, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 30, 2025 •

edited

Loading

coderabbitai bot commented Jun 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)