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

Reword invoke_pin action to avoid misunderstanding with "PIN" #133665

Merged
merged 2 commits into from
Dec 20, 2024

Conversation

NoRi2909
Copy link
Contributor

@NoRi2909 NoRi2909 commented Dec 20, 2024

Proposed change

The previous mismatch between "PIN" and "pin" in the invoke_pin action caused wrong translations as "PIN" was interpreted as the abbreviation for "Personal Identification Number".

This commit fixes this by explaining "pin" as related to "pinning" content on the device.

In addition the very technical term "invoke" is replaced by "play" which every user and translator will understand immediately.

Along with those changes this PR reverts my previous PR to use "PIN" in all strings that made things worse.

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:

The previous mismatch between "PIN" and "pin" in the invoke_pin caused wrong translations as "PIN" was interpreted as the abbreviation for "Personal Identification Number".

This commit fixes this by explaining "pin" as related to "pinning" content on the device.

In addition the very "invoke" is replaced by "play" which every user and translator will understand immediately.

Along with those changes this commit reverts my previous change to "PIN" in all strings that made things worse.
@home-assistant
Copy link

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

Code owner commands

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

Copy link
Member

@zweckj zweckj left a comment

Choose a reason for hiding this comment

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

What about the other pins? Can those stay caps?

homeassistant/components/openhome/strings.json Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft December 20, 2024 15:46
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@NoRi2909
Copy link
Contributor Author

NoRi2909 commented Dec 20, 2024

@zweckj As suggested by @bazwilliams I changed all occurences of "PIN" to "pin" so it no longer looks like the abbreviation.

There are six Pins on the device and Linn's docs also use both spellings.

Here a mockup of all the changes in the UI:

image

@NoRi2909 NoRi2909 requested a review from zweckj December 20, 2024 15:54
@zweckj
Copy link
Member

zweckj commented Dec 20, 2024

That one I'm happy with, the others could still be improved imo -> check suggestions

@NoRi2909
Copy link
Contributor Author

@zweckj Everything contained in the strings.json is visible in my mockup above.
There are no other strings left as it contains this action, only.

So if the mockup is OK with you and @bazwilliams there is nothing left to change?

@NoRi2909 NoRi2909 marked this pull request as ready for review December 20, 2024 18:06
@zweckj zweckj merged commit c780933 into home-assistant:dev Dec 20, 2024
30 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 21, 2024
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.

3 participants