Add 'always' as a valid time refresh value #4392
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe documentation for ESPHome's configuration types has been updated to include a new option for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant ESPHome
User->>Documentation: View configuration types
Documentation->>User: Display options
User->>Documentation: Learn about update_interval
Documentation->>User: Show update_interval: always
User->>ESPHome: Configure update_interval: always
ESPHome->>User: Process updates in every loop iteration
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
guides/configuration-types.rst (1)
163-165: Consider restructuring special update_interval values for better clarity.The special values (never, 0ms, always) could be more clearly organized. Consider using a bullet list or table format:
- update_interval: never # never update - update_interval: 0ms # update in every loop() iteration - update_interval: always # same as 0ms + # Special update_interval values: + # - never: never update + # - 0ms or always: update in every loop() iteration
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- guides/configuration-types.rst (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
guides/configuration-types.rst (1)
Pattern
**: - Do not generate or add any sequence diagrams
🔇 Additional comments (1)
guides/configuration-types.rst (1)
165-165: LGTM! The addition is clear and well-placed.The new 'always' option is documented correctly and its equivalence to '0ms' is clearly stated.
Description:
Add 'always' as a valid time value. It is more explicit to user than 0s ou 0ms and already supported is the core code, see:
https://github.com/esphome/esphome/blob/21cb941bbe7afb7096ee342fae2c88bdaa27d28b/esphome/config_validation.py#L1981C26-L1981C32
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.