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.

Sign up for GitHub

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

Jump to bottom

Update translations and error messages in Bring! integration #135455

Merged
merged 3 commits into from
Jan 12, 2025
Merged

Update translations and error messages in Bring! integration #135455

merged 3 commits into from
Jan 12, 2025

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented Jan 12, 2025 •
edited
Loading

Proposed change

Follow-up to #135446

  • Updated the labels for the notifications so that they are en par with the button labels in the latest version of the Bring! app
    image

  • Updated missing argument exception to be consistent with other Home Assistant error messages

  • Change field name from Articles to Items for consistency

  • Removed backticks and replaced with single quotes were HA doesn't support markdown formatting.

Tests have been updated and a now unnecessary translation placeholder has been removed (changed key to prevent conflicts)

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 @miaucl, mind taking a look at this pull request as it has been labeled with an integration (bring) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of bring 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 bring 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.

@tr4nt0r
Copy link
Contributor Author

tr4nt0r commented Jan 12, 2025

@NoRi2909 looks good? 👀

@NoRi2909
Copy link
Contributor

@tr4nt0r The strings look fine to me, I'd just use uppercase "Item" here as it's the field name:

"message": "This action requires field item, please enter a valid value for item"

@tr4nt0r
Copy link
Contributor Author

tr4nt0r commented Jan 12, 2025

@NoRi2909 oh, that's correct like that. Home Assistant uses the field name in error messages (not the label from the translation string). item is in deed the actual field name

image

@NoRi2909
Copy link
Contributor

NoRi2909 commented Jan 12, 2025 •
edited
Loading

Yes, the field key is item , but for UI strings we should use the friendly names defined in the UI.
In English you changed this to "Item" as well so it's (almost) consistent there.

But as the error string is exposed to Lokalise "item" will be either translated or no longer match the field name the user sees in the UI. And the error message shows up below the action in Dev Tools, too.

Thus I think using the English UI name here, meaning uppercase "Item", is the right way to go.
In German we will probably keep "Artikel" for this in both places and we both don't know what all the other translators will do here.

@tr4nt0r
Copy link
Contributor Author

tr4nt0r commented Jan 12, 2025

@NoRi2909 I changed it now to use a placeholder, so that it doesn't get translated. As you can see in the screenshot, this is how it is handled elsewhere, the field name is used, not the friendly name.

image

@NoRi2909
Copy link
Contributor

@tr4nt0r OK, that's the best solution!

I just look at all this with the eyes of a translator who is (sometimes desperately) searching for hints if we should translate some word or not.
As Home Assistant generally uses sentence-case it's easy to spot anything that should be treated as a name as they stick out in uppercase. Then I just need to check if that is used in some related string so we keep the translations consistent.

Thanks for your quick fixes!

Grüße aus Koblenz nach Berlin. :-)

jbouwh
jbouwh approved these changes Jan 12, 2025
View reviewed changes
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

LGTM,
Thanks @tr4nt0r 👍

@jbouwh jbouwh merged commit ccb94ac into home-assistant:dev Jan 12, 2025
34 checks passed
@tr4nt0r tr4nt0r deleted the bring_translations branch January 12, 2025 15:56
dotvav pushed a commit to dotvav/home-assistant-core that referenced this pull request Jan 13, 2025
@tr4nt0r @dotvav
Update translations and error messages in Bring! integration (home-as…
afd4f9a 
…sistant#135455)

* Update translations and error messages

* use placeholder for field name

* change key for translation string
dotvav pushed a commit to dotvav/home-assistant-core that referenced this pull request Jan 13, 2025
@tr4nt0r @dotvav
Update translations and error messages in Bring! integration (home-as…
f477a3e 
…sistant#135455)

* Update translations and error messages

* use placeholder for field name

* change key for translation string
@github-actions github-actions bot locked and limited conversation to collaborators Jan 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jbouwh jbouwh jbouwh approved these changes

Assignees
No one assigned
Labels
by-code-owner cla-signed code-quality has-tests integration: bring Quality Scale: No score small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tr4nt0r @NoRi2909 @jbouwh