Skip to content
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.

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

Replace keys with translatable friendly names in Statistics helper #136936

Merged
merged 2 commits into from
Feb 1, 2025

Conversation

NoRi2909
Copy link
Contributor

Proposed change

The Statistics helper UI still uses the internal key names for some field descriptions and error messages.
As these cannot be translated they are not helpful in localized UIs:

image

This PR fixes this by replacing them with the friendly names in the dialog, all capitalized to recognize them as field labels.

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:

Checklist

  • 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.

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

Code owners of statistics can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign statistics Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@gjohansson-ST
Copy link
Member

Why can they not be translated? I think they can, but we seem not to do it?

@NoRi2909
Copy link
Contributor Author

Well, anything with underscores like max_age, sampling_size and keep_last_sample will not be translated in Lokalise.

But when we use the field labels from the UI like 'Max age', 'Sampling size' and 'Keep last sample' this mandates a translation so it matches the rest of the UI seen by the user in his or her language.

We already applied a bunch of similar fixes to other integrations to ensure proper translations.

@gjohansson-ST
Copy link
Member

That's what I sort of meant. That if we put in proper text, then the friends who translate would do this also for these field names?

@NoRi2909
Copy link
Contributor Author

As I'm doing the translations for German I can assure you that we'll do that here. :-)

For the other languages I cannot tell you how much cross-checking is done there.
But the first step is to get rid of the key names that prevent proper translations.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @NoRi2909 👍

@gjohansson-ST gjohansson-ST merged commit 123cd92 into home-assistant:dev Feb 1, 2025
32 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 2, 2025
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.

2 participants