core icon indicating copy to clipboard operation
core copied to clipboard

Improve the readability of status messages in NUT

Open bonanitech opened this issue 9 months ago • 4 comments

Breaking change

Proposed change

Improve the readability of status messages by separating them by commas.

Type of change

  • [ ] Dependency upgrade
  • [x] 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 #130622
  • 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
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] 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:

bonanitech avatar Mar 25 '25 02:03 bonanitech

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

Code owner commands

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

home-assistant[bot] avatar Mar 25 '25 02:03 home-assistant[bot]

This is a breaking change since the return values of the status sensor will change. The breaking change section and explanation should be provided.

tdfountain avatar Mar 25 '25 02:03 tdfountain

@home-assistant rename Improve the readability of status messages in NUT

tdfountain avatar Mar 25 '25 04:03 tdfountain

Please add Breaking Change as noted.

I had no idea it would be a breaking change. What should I add there?

bonanitech avatar Mar 25 '25 11:03 bonanitech

I changed it to Breaking Change, but I don't know what to add as an explanation there.

bonanitech avatar Mar 28 '25 10:03 bonanitech

I changed it to Breaking Change, but I don't know what to add as an explanation there.

Added an note to the first chapter.

frenck avatar Mar 30 '25 14:03 frenck