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

Make To-do action names and descriptions consistent with HA standard #133734

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

NoRi2909
Copy link
Contributor

@NoRi2909 NoRi2909 commented Dec 21, 2024

Proposed change

Currently all actions of the To-do integration repeat "to-do list" in their friendly names which adds a lot of noise in the UI making them really hard to read them at a quick glance:

image

(That single screenshot above contains 16 occurrences of "to-do list")

This PR reduces them back to shorter names that are identical to the internal names.

In the UI this will result in:

  • To-do list: Add item
  • To-do list: Get items
  • To-do list: Update item
  • To-do list: Remove item
  • To.do list: Remove completed items

In addition it changes all descriptions to use the common way of describing their purpose with what each one does: "Adds …", "Gets …", "Updates …", and "Removes …"

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:

Currently all actions of the To-do integration repeat "To-do list" in their friendly names which makes it really hard to read them at a quick glance.

This commit reduces them back to shorter names that are mostly identical with the internal names.

In the UI this will result in:

- To-do list: Add item
- To-do list: Get items
- To-do list: Update item
- To-do list: Remove item
- To.do list: Remove all completed items

In addition it changes all descriptions to use the common way of describing their purpose with what each one does:
"Adds …", "Gets …", "Updates …", and "Removes …"
@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (todo) you are listed as a code owner for? Thanks!

Code owner commands

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

Overlooked that in the initial commit.
@NoRi2909
Copy link
Contributor Author

Just for the record: The PR also makes this more consistent with how the Shopping list actions already look today – regarding both the names and the descriptions:

image

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.

1 participant