Skip to content

Add data descriptions for nobo_hub config and options flows#168723

Merged
joostlek merged 2 commits into
home-assistant:devfrom
oyvindwe:nobo_hub-data-descriptions
Apr 21, 2026
Merged

Add data descriptions for nobo_hub config and options flows#168723
joostlek merged 2 commits into
home-assistant:devfrom
oyvindwe:nobo_hub-data-descriptions

Conversation

@oyvindwe
Copy link
Copy Markdown
Contributor

Proposed change

Context: This is PR 4 of 6 to get nobo_hub to the Bronze level on the quality scale.

Add data descriptions for nobo_hub config and options flows.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @echoromeo, mind taking a look at this pull request as it has been labeled with an integration (nobo_hub) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of nobo_hub can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign nobo_hub Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the Nobø Ecohub (nobo_hub) integration’s UX by adding data_description help text for fields in the config flow (manual/selected/user) and options flow, supporting the integration’s move toward Bronze quality scale.

Changes:

  • Add field-level data_description entries for config flow steps (manual, selected, user).
  • Add field-level data_description for the options flow override_type field.

Comment thread homeassistant/components/nobo_hub/strings.json Outdated
Comment thread homeassistant/components/nobo_hub/strings.json Outdated
Copy link
Copy Markdown
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Copilot has good comments

@joostlek joostlek merged commit 4a93dcb into home-assistant:dev Apr 21, 2026
33 checks passed
@oyvindwe
Copy link
Copy Markdown
Contributor Author

Copilot has good comments

Applied both suggestions. Claude had a comment though:

Minor concern: that duplicates the text verbatim. HA convention is description = step-level context, data_description = per-field help. Since this step has one field, duplication is acceptable here — but alternatively I could make description terser (e.g. "Choose how global overrides are ended.") and trust data_description for the details.

@oyvindwe oyvindwe deleted the nobo_hub-data-descriptions branch April 21, 2026 16:03
@joostlek
Copy link
Copy Markdown
Member

I think we can pick the most logical one, no need to duplicate

Copy link
Copy Markdown
Contributor

@NoRi2909 NoRi2909 left a comment

Choose a reason for hiding this comment

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

Noticed post-merge in Lokalise:

},
"description": "Select override type \"Now\" to end override on next week profile change."
"data_description": {
"override_type": "Select \"Now\" to end a global override on the next week profile change, or \"Constant\" to keep it until manually cleared."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Those options "Now" and "Constant" don't have translations, yet.

So when they remain English in the UI and need to be typed in, they should be enclosed in backticks.
Otherwise we translators (and Google Translate / Deepl) do translate them causing a mismatch.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've addressed this in the follow-up PR #168740

I'll also look into translating Now and Constant.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Translations for "Now" and "Constant" added in PR #168752

"data_description": {
"override_type": "Select \"Now\" to end a global override on the next week profile change, or \"Constant\" to keep it until manually cleared."
},
"description": "Select \"Now\" to end a global override on the next week profile change, or \"Constant\" to keep it until manually cleared."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is identical to the field's data_description so it would be duplicated in the UI?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, that was my (and Claude's) concern as well, but I commented post-merge as well.

I've addressed this in the follow-up PR #168740

@github-actions github-actions Bot locked and limited conversation to collaborators Apr 23, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants