Skip to content

Add data_description to airnow config flow strings#169783

Merged
erwindouna merged 2 commits into
home-assistant:devfrom
HoffmanEl:fix-airnow-strings
May 5, 2026
Merged

Add data_description to airnow config flow strings#169783
erwindouna merged 2 commits into
home-assistant:devfrom
HoffmanEl:fix-airnow-strings

Conversation

@HoffmanEl
Copy link
Copy Markdown
Contributor

Breaking change

Proposed change

Add data_description helper text to the airnow config flow strings,
providing clearer guidance to users during setup.

Changes:

  • Added data_description for api_key, latitude, longitude and radius fields
  • Updated description text to be grammatically correct

Note: This was split from #169709 at reviewer request.

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

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings May 5, 2026 00:51
@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented May 5, 2026

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

Code owner commands

Code owners of airnow can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign airnow Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the AirNow integration’s config flow translations to provide clearer setup guidance in the user-facing form. It is a small localization/UI text change within the integration’s existing config flow strings.

Changes:

  • Added data_description helper text for the API key, latitude, longitude, and radius fields.
  • Updated the existing config flow description text for grammar and punctuation.
  • Kept the changes isolated to the AirNow integration’s strings.json file, matching the PR’s stated scope.

@HoffmanEl HoffmanEl marked this pull request as draft May 5, 2026 00:54
@HoffmanEl HoffmanEl marked this pull request as ready for review May 5, 2026 01:04
Copilot AI review requested due to automatic review settings May 5, 2026 01:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Copy link
Copy Markdown
Member

@erwindouna erwindouna left a comment

Choose a reason for hiding this comment

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

Thanks @HoffmanEl!

@erwindouna erwindouna merged commit 38de48a into home-assistant:dev May 5, 2026
36 of 37 checks passed
},
"description": "To generate API key go to {api_key_url}"
"data_description": {
"api_key": "To generate an API key, go to {api_key_url}.",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is identical to the description in line 26 that already shows up above the entry fields.
Should be just something like "The API key for accessing AirNow data." then.

rajlaud pushed a commit to rajlaud/home-assistant that referenced this pull request May 5, 2026
@github-actions github-actions Bot locked and limited conversation to collaborators May 6, 2026
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.

4 participants