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

Update two strings for creating a Utility meter Helper #131196

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

NoRi2909
Copy link
Contributor

@NoRi2909 NoRi2909 commented Nov 21, 2024

Anything the user creates in Home Assistant should use "Create …", not "Add …" following the Home Assistant Design guidelines .

The Utility Meter helper is one of the few remaining Helper types that still uses "Add":

image

In the description above in the screen shot "energy" is used to refer to electricity. But "energy" covers "gas" and "heating" as well, so this is misleading.

Therefore it should say "electricity, gas, water and heating" instead.

Changing this for consistency with translations, too:
For example in German we'd definitely say "Strom" (electricity) here.

Proposed change

Replace "Add" with "Create" in the headline.
Replace "energy" with "electricity" in the description.

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

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:

Anything the user creates in Home Assistant should use "Create …", not "Add …". This fixes the headline and makes it consistent with the description just below it.

"Energy" covers "Gas" and "Heating" as well, what's meant here is "Electricity", changes this for proper translations, too.
@home-assistant
Copy link

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

Code owner commands

Code owners of utility_meter 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 utility_meter 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

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Anything the user creates in Home Assistant should use "Create …", not "Add …".

Based on?

Please note, this adds an integration... which we call "add" everywhere.

"Energy" covers "Gas" and "Heating" as well, what's meant here is "Electricity".

Incorrect. The use of this integration is not limited to electricity (although a common use case).

../Frenck

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

@home-assistant home-assistant bot marked this pull request as draft November 21, 2024 18:22
@NoRi2909
Copy link
Contributor Author

NoRi2909 commented Nov 21, 2024

@frenck It's part of the Home Assistant Design guidelines
I already did half a dozen PR today based on that, so sorry for me getting lazy to include the link.

The line "Create Utility Meter" is the headline of the Helper this creates. It is not related to adding the integration.

image

You misunderstood my explanation regarding "energy" vs. "electricity": The suggested change does not remove "gas" and "heating", it just changes "energy" into "electricity" as this is what you get from your utility.

Energy is the overarching term, the meters are for electricity, gas, district heating (or water).
The suggested change to the description reflects that.

See the string below the headline in the screenshot.

@NoRi2909 NoRi2909 changed the title Update two stings in the Utility meter component Update two strings for creating a Utility meter Helper Nov 21, 2024
@NoRi2909
Copy link
Contributor Author

I've updated the complete description of the PR to avoid all the misunderstandings I created by keeping this too short.
I hope it's now much clearer.

Was a bit of marathon for me today and on the last miles I started to fail …

@NoRi2909 NoRi2909 requested a review from frenck November 21, 2024 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants