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

OpenWeatherMap remove obsolete forecast sensors #33320

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

freekode
Copy link
Contributor

@freekode freekode commented Jun 18, 2024

Proposed change

Remove obsolete forecast sensors as they were fully replaced by weather.get_forecasts service.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Corrected text, capitalization, and formatting in the OpenWeatherMap integration.
    • Updated wind speed units from "metre/sec" to "meter/sec".

@freekode freekode requested a review from fabaff as a code owner June 18, 2024 20:57
@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Jun 18, 2024
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

Copy link
Contributor

coderabbitai bot commented Jun 18, 2024

Walkthrough

Walkthrough

The openweathermap integration has undergone several text corrections, including capitalization and formatting. Semantic changes include the removal of forecast weather condition details and the adjustment of units for wind speed from "metre/sec" to "meter/sec".

Changes

Files Change Summary
.../openweathermap.markdown Text corrections, capitalization, and formatting.
.../openweathermap.markdown Removal of forecast weather conditions.
.../openweathermap.markdown Adjustment of wind speed units (metre to meter).

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 71a84df and 13cf5be.

Files selected for processing (1)
  • source/_integrations/openweathermap.markdown (3 hunks)
Additional context used
LanguageTool
source/_integrations/openweathermap.markdown

[misspelling] ~21-~21: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ..._integration_type: integration --- The OpenWeatherMap weather integrations uses [OpenWeatherM...


[misspelling] ~21-~21: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...enWeatherMap weather integrations uses OpenWeatherMap as a sour...


[misspelling] ~28-~28: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: .../day. Consider setting the limit on the OpenWeatherMap website to stay under the threshold whe...


[misspelling] ~32-~32: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...## ⚠️ Important Deprecation Notice ### OpenWeatherMap API V2.5 Deprecation OpenWeatherMap AP...


[misspelling] ~33-~33: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...## OpenWeatherMap API V2.5 Deprecation OpenWeatherMap API V2.5 will be closed in June 2024. A...


[misspelling] ~38-~38: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ontinue using the service: - Visit the OpenWeatherMap website and activate the One Call subsc...


[misspelling] ~40-~40: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... the free tier limits. - Configure your OWM integration to select mode v3.0. - No...


[misspelling] ~43-~43: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...mits on your usage to avoid charges at [OpenWeatherMap Subscriptions](https://home.openweather...


[misspelling] ~47-~47: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...e'> If you register a new API key with OpenWeatherMap, it will be activated automatically, th...


[typographical] ~48-~48: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’. (COMMA_THAT_NOUN)
Context: ...n mind when configuring this integration, that your new API key might not be activated...


[misspelling] ~84-~84: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ets begin to condense and dew can form, ºC. ...


[misspelling] ~85-~85: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ng for the human perception of weather, ºC. ...


[misspelling] ~88-~88: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... | Atmospheric pressure at sea level, hPa. ...


[misspelling] ~91-~91: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...temperature | Temperature, ºC. ...


[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... | | uv_index | UV Index. ...


[non-conformance] ~94-~94: Please check whether ‘whether’ (as in ‘whether or not’) might be the correct word here instead of ‘weather’ (atmospheric conditions). (CONFUSION_RULE_WEATHER_WHETHER)
Context: ... | | weather | A human-readable desc...


[non-conformance] ~95-~95: Please check whether ‘whether’ (as in ‘whether or not’) might be the correct word here instead of ‘weather’ (atmospheric conditions). (CONFUSION_RULE_WEATHER_WHETHER)
Context: ...ditions#Weather-Condition-Codes-2). | | weather_code | ID of the [weather co...


[misspelling] ~99-~99: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ils about the API are available in the [OpenWeatherMap documentation](https://openweathermap.o...

Markdownlint
source/_integrations/openweathermap.markdown

45-45: Element: div (MD033, no-inline-html)
Inline HTML


70-70: Element: div (MD033, no-inline-html)
Inline HTML

Additional comments not posted (1)
source/_integrations/openweathermap.markdown (1)

97-97: Update the unit of measurement for wind speed to maintain consistency.

This change aligns with the semantic update from "metre/sec" to "meter/sec", enhancing consistency in the documentation.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Jun 18, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 13cf5be
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6671f4b79ac5900008efae7a
😎 Deploy Preview https://deploy-preview-33320--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@home-assistant home-assistant bot removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Jun 18, 2024
@home-assistant home-assistant bot added the has-parent This PR has a parent PR in a other repo label Jun 18, 2024
@freekode
Copy link
Contributor Author

@coderabbitai review

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

Comment on lines +47 to +48
If you register a new API key with OpenWeatherMap, it will be activated automatically, this typically takes between 10 minutes and 2 hours
after your successful registration. Keep in mind when configuring this integration, that your new API key might
Copy link
Contributor

@coderabbitai coderabbitai bot Jun 19, 2024

Choose a reason for hiding this comment

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

The note about API key activation could be made clearer.

Consider rephrasing for clarity and conciseness:

- If you register a new API key with OpenWeatherMap, it will be activated automatically, this typically takes between 10 minutes and 2 hours after your successful registration. Keep in mind when configuring this integration, that your new API key might not be activated yet.
+ When registering a new API key with OpenWeatherMap, activation typically occurs within 10 minutes to 2 hours. Ensure the key is active before using it in this integration.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
If you register a new API key with OpenWeatherMap, it will be activated automatically, this typically takes between 10 minutes and 2 hours
after your successful registration. Keep in mind when configuring this integration, that your new API key might
If you register a new API key with OpenWeatherMap, it will be activated automatically, this typically takes between 10 minutes and 2 hours
after your successful registration. Keep in mind when configuring this integration, that your new API key might
When registering a new API key with OpenWeatherMap, activation typically occurs within 10 minutes to 2 hours. Ensure the key is active before using it in this integration.
Tools
LanguageTool

[misspelling] ~47-~47: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...e'> If you register a new API key with OpenWeatherMap, it will be activated automatically, th...


[typographical] ~48-~48: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’. (COMMA_THAT_NOUN)
Context: ...n mind when configuring this integration, that your new API key might not be activated...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just wanted to fix small mistakes, not rephrase whole section.

Copy link
Contributor

Choose a reason for hiding this comment

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

@freekode, understood! I've noted your preference for focusing on minor corrections. The suggested changes have been adjusted to address just the small errors as you intended. If there's anything else you need, feel free to let me know!

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @freekode 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Jun 21, 2024
@frenck frenck merged commit 18f56df into home-assistant:next Jun 21, 2024
6 checks passed
@home-assistant home-assistant bot removed awaits-parent Awaits the merge of an parent PR in-progress This PR/Issue is currently being worked on labels Jun 21, 2024
@freekode freekode deleted the owm-remove-sensors branch June 21, 2024 10:24
@github-actions github-actions bot locked and limited conversation to collaborators Jun 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants