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

Add exceptions translations for Shelly integration #141071

Merged
merged 11 commits into from
Mar 24, 2025

Conversation

bieniu
Copy link
Member

@bieniu bieniu commented Mar 21, 2025

Breaking change

Proposed change

Adds exceptions translations for Shelly integration,

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

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

Code owner commands

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

@@ -204,11 +204,44 @@
}
},
"exceptions": {
"auth_error": {
"message": "Authentication failed for {device} device, please update your credentials"
Copy link
Contributor

Choose a reason for hiding this comment

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

Question for translations:
Is {device} replaced with the friendly device name like "Shelly RGBW2 Living room"?

Copy link
Member

Choose a reason for hiding this comment

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

Question for translations:
Is {device} replaced with the friendly device name like "Shelly RGBW2 Living room"?

Yes

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, I wonder if that "… {device} device …" makes sense in that context:

"Authentication failed for Shelly RGBW2 Living room device, please update your credentials"

does sound over-complicated to me. I'd just use

"Authentication failed for Shelly RGBW2 Living room, please update your credentials"

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm it depends on how someone names their devices but probably you're right, the word device is not needed. Tomorrow I will update PR.

Copy link
Member

@frenck frenck Mar 21, 2025

Choose a reason for hiding this comment

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

The config entry can have a different name as well, so that doesn't have to be a fit.

One is reauthing the entry, not the device.

Copy link
Contributor

Choose a reason for hiding this comment

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

That'll be great. In German I have to really twist the grammar to the limit to keep "device" (and also "entity" in the messages from the previous PR) in the translated messages.

With just the names everything is a lot simpler although we might have to enclose the device or entity names with quotes to keep any naming the user has chosen together as a single item in the sentences.
In English and many other languages they stand out thanks to capitalization. In German we capitalize all nouns so this does make things a bit more difficult.

Copy link
Member Author

Choose a reason for hiding this comment

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

and also "entity" in the messages from the previous PR

Which PR do you mean?

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant #140578 which added two exception messages.
I see you also removed "device" from those with the last commit.

Perhaps "… entity {entity} …" in those can be reworded, too.

Copy link
Member Author

Choose a reason for hiding this comment

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

But here the meaning is different, it is about calling an action for an entity, e.g. turn_on for a switch: "calling the entity {entity} action".
Maybe "calling action for {entity} for {device}" will be easier to translate?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, that's much better and easier to translate now. Thanks! 👍

@frenck frenck marked this pull request as draft March 21, 2025 20:05
@bieniu bieniu marked this pull request as ready for review March 22, 2025 10:56
@frenck frenck merged commit 95cc3e3 into home-assistant:dev Mar 24, 2025
34 checks passed
@bieniu bieniu deleted the shelly-exc-translations branch March 24, 2025 18:06
@github-actions github-actions bot locked and limited conversation to collaborators Mar 25, 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.

7 participants