Skip to content

Conversation

gjohansson-ST
Copy link
Member

@gjohansson-ST gjohansson-ST commented Oct 6, 2025

Proposed change

SSIA
Core PR: home-assistant/core#153572

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Updated wind-related property descriptions to include the Beaufort scale as a valid unit option alongside m/s, km/h, mi/h, ft/s, and kn.
    • Clarified unit guidance for native_wind_speed and native_wind_gust_speed (including required conditions when native_wind_speed is set) and clarified forecast field representations.
    • No runtime or validation changes; documentation-only clarity improvements.

Copy link
Contributor

coderabbitai bot commented Oct 6, 2025

📝 Walkthrough

Walkthrough

Documentation update: wind-related fields in the weather entity now list Beaufort as an allowed representation for native_wind_gust_speed, native_wind_speed, and native_wind_speed_unit. Forecast wind fields’ data types shown as int (instead of float) in docs. No runtime, validation, or control-flow changes.

Changes

Cohort / File(s) Change Summary
Docs: Weather entity wind properties
docs/core/entity/weather.md
Added Beaufort to allowed units for native_wind_gust_speed, native_wind_speed, and native_wind_speed_unit (Beaufort, m/s, km/h, mi/h, ft/s, kn). Adjusted forecast wind fields to display type int instead of float. Documentation-only edits; no behavioral changes.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The PR description retains the full template but does not provide a clear summary in the "Proposed change" section beyond "SSIA," leaves the checklist items unchecked, and fails to fill out the "Additional information" fields, resulting in incomplete documentation of scope and context. Please expand the "Proposed change" to describe the documentation updates in plain language, check off the relevant checklist items, and complete the "Additional information" section by linking the related core PR and any issues being addressed.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately describes the main change, which is adding the Beaufort unit to the weather entity documentation. It is concise and clearly conveys the primary update without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch gj-20251006-01

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 68899d7 and 66a6bcd.

📒 Files selected for processing (1)
  • docs/core/entity/weather.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/core/entity/weather.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ef1dc2f and 68899d7.

📒 Files selected for processing (1)
  • docs/core/entity/weather.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant

| native_wind_speed_unit | string | `None` | The wind speed unit;m/s, km/h, mi/h, ft/s or kn. Required if native_wind_speed is set.
| native_wind_gust_speed | float | `None` | The current wind gust speed in Beaufort, m/s, km/h, mi/h, ft/s or kn.
| native_wind_speed | float | `None` | The current wind speed in Beaufort, m/s, km/h, mi/h, ft/s or kn.
| native_wind_speed_unit | string | `None` | The wind speed unit; Beaufort, m/s, km/h, mi/h, ft/s or kn. Required if native_wind_speed is set.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| native_wind_speed_unit | string | `None` | The wind speed unit; Beaufort, m/s, km/h, mi/h, ft/s or kn. Required if native_wind_speed is set.
| native_wind_speed_unit | string | `None` | The wind speed unit in Beaufort, m/s, km/h, mi/h, ft/s or kn. Required if native_wind_speed is set.

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.

2 participants