home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Add forecast service call for extra attributes for nws

Open MatthewFlamm opened this issue 1 year ago β€’ 2 comments

Proposed change

Documentation for new service to return extra data for forecasts that are not yet supported by weather platform. For https://github.com/home-assistant/core/pull/117254.

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).
  • [x] Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • [ ] Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/117254
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • [x] 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.
  • [x] The documentation follows the Home Assistant documentation standards.

MatthewFlamm avatar May 13 '24 18:05 MatthewFlamm

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit b6a33699da47d64868afe6373a83ee0a22de1c55
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/669a14c5d184df0008859998
Deploy Preview https://deploy-preview-32729--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.

netlify[bot] avatar May 13 '24 18:05 netlify[bot]

I've always thought the requirements for a platform using heterogeneous APIs should be a common baseline and not a limit. This is in the direction of goodness.

Sudo-Rob avatar May 14 '24 22:05 Sudo-Rob

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

home-assistant[bot] avatar Jul 18 '24 14:07 home-assistant[bot]

Walkthrough

Walkthrough

The changes introduce a new action nws.get_forecasts_extra in the nws.markdown file, enhancing weather forecast capabilities. This functionality includes additional attributes such as type, datetime, is_daytime, detailed_description, and short_description, providing a more comprehensive view of forecast data. The response structure has been updated accordingly, and the documentation has been revised to incorporate details about this new action and its usage.

Changes

Files Change Summary
source/_integrations/nws.markdown Introduced the nws.get_forecasts_extra action for enhanced weather forecasts, including attributes like type, datetime, and descriptions. Documentation updated to reflect these changes.

Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8980b7f90a16a1e91e0357ecf9180286781fbd4d and b6a33699da47d64868afe6373a83ee0a22de1c55.

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

[style] ~50-~50: This phrase is redundant. Consider writing β€œpoint” or β€œtime”. Context: ...ist of forecasted conditions at a given point in time that are not returned from `weather.get...

(MOMENT_IN_TIME)


[uncategorized] ~57-~57: Possible missing preposition found. Context: ...ition | Partly Sunny then Slight Chance Showers And Thunderstorms | ## Details Detail...

(AI_EN_LECTOR_MISSING_PREPOSITION)

Markdownlint
source/_integrations/nws.markdown

31-31: Expected: 0 or 2; Actual: 1 Trailing spaces

(MD009, no-trailing-spaces)

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

59-61: LGTM!

The section providing additional details about the API looks good.


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 Configuration 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.

coderabbitai[bot] avatar Jul 18 '24 18:07 coderabbitai[bot]

I updated based on the changes in the core PR, also I needed to make some changes due to a recent change in language from service->action. Hopefully I captured that change correctly here.

MatthewFlamm avatar Jul 18 '24 18:07 MatthewFlamm

@gjohansson-ST, are you good with the changes?

c0ffeeca7 avatar Jul 19 '24 07:07 c0ffeeca7

@c0ffeeca7 I'm good with it πŸ‘

gjohansson-ST avatar Jul 19 '24 08:07 gjohansson-ST