Z-Wave JS: Rename watchdog option to avoid confusion with add-on watchdog #3802
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe changes involve modifications across several files related to the Z-Wave JS configuration. The Changes
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)
zwave_js/translations/en.yaml (1)
Line range hint
81-85: Approved: Improved clarity in watchdog setting nameThe renaming of
disable_watchdogtoDisable Z-Wave JS (hardware) watchdogeffectively addresses the PR objective by clearly distinguishing it from the add-on watchdog. This change enhances user understanding without altering the functionality.Consider slightly modifying the description to reinforce the distinction:
This setting will prevent Z-Wave JS from enabling the hardware watchdog - on supporting controllers. In most cases, users will never need to use + on supporting Z-Wave controllers. In most cases, users will never need to use this feature, so only change this setting if you know what you are doing and/or you are asked to.This minor adjustment further emphasizes that the setting is specific to Z-Wave controllers, aligning with the clarified name.
|
Do we need to make a new release? |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
done |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
zwave_js/CHANGELOG.md (1)
3-6: Enhance the changelog entry with more specific details.The changelog entry could be more helpful by including:
- The old vs new name of the watchdog option
- The location where users can find this configuration option
Consider expanding the entry like this:
## 0.8.1 -Rename Z-Wave watchdog option to avoid confusion with add-on watchdog. +Rename configuration option "disable_watchdog" to "Disable Z-Wave JS (hardware) watchdog" to avoid confusion with the add-on watchdog functionality. This option can be found in the add-on configuration UI.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- zwave_js/CHANGELOG.md (1 hunks)
- zwave_js/config.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- zwave_js/config.yaml
🧰 Additional context used
📓 Path-based instructions (1)
zwave_js/CHANGELOG.md (6)
Pattern
*/**(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'
Pattern
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern
*/**(html|markdown|md): do not comment on HTML used for icons
Pattern
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
Summary by CodeRabbit
New Features
Chores