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

Update lawn-mower.md with returning state #2280

Merged

Conversation

mikey0000
Copy link
Contributor

@mikey0000 mikey0000 commented Aug 20, 2024

Update lawn mower state with returning

core: home-assistant/core#124261
architecture: home-assistant/architecture#1123
frontend: home-assistant/frontend#21740

Proposed change

Type of change

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

Additional information

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

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Introduced a new operational state, RETURNING, for the lawn mower, providing enhanced feedback on its activity as it returns to the docking station.
  • Documentation
    • Added multiple documentation entries detailing the RETURNING state and its implementation within the Home Assistant ecosystem, improving clarity on managing the lawn mower's operational statuses.

Copy link
Contributor

coderabbitai bot commented Aug 20, 2024

Walkthrough

Walkthrough

The recent update introduces a new state, RETURNING, for the lawn mower, indicating when it is returning to its docking station after completing its mowing task. This change enhances state management by providing additional feedback on its operational status, while the existing states remain intact.

Changes

Files Change Summary
docs/core/entity/lawn-mower.md Added a new state declaration RETURNING for the lawn mower.
blog/2024-09-04-lawn-mower-activity-returning.md Introduced documentation for LawnMowerActivity.RETURNING, detailing its implementation and usage.
blog/2024-08-23-lawn-mower-activity-returning.md Documented the implementation of LawnMowerActivity.RETURNING for asynchronous docking methods and state updates.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LawnMower
    participant Dock

    User->>LawnMower: Start mowing
    LawnMower->>LawnMower: Change state to MOWING
    LawnMower->>User: Mowing in progress

    LawnMower->>LawnMower: Finish mowing
    LawnMower->>LawnMower: Change state to RETURNING
    LawnMower->>Dock: Move to docking station
    Dock->>LawnMower: Docked
    LawnMower->>LawnMower: Change state to DOCKED
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b030e9 and 11d9cc7.

Files selected for processing (1)
  • blog/2024-08-23-lawn-mower-activity-returning.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • blog/2024-08-23-lawn-mower-activity-returning.md

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.

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: 0

Outside diff range, codebase verification and nitpick comments (1)
docs/core/entity/lawn-mower.md (1)

26-26: Consider adding the article "the".

In the description for the RETURNING state, consider adding the article "the" for grammatical correctness.

- | `RETURNING` | The lawn mower is returning to dock.
+ | `RETURNING` | The lawn mower is returning to the dock.
Tools
LanguageTool

[uncategorized] ~26-~26: You might be missing the article “the” here.
Context: ...RNING| The lawn mower is returning to dock. |ERROR` | The lawn mower encountere...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

@gjohansson-ST
Copy link
Member

This PR should include a blog post explaining the new activity returning and how to use it 👍

@mikey0000
Copy link
Contributor Author

This PR should include a blog post explaining the new activity returning and how to use it 👍

Done.

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
mikey0000 and others added 3 commits August 22, 2024 07:29
Co-authored-by: G Johansson <goran.johansson@shiftit.se>
Co-authored-by: G Johansson <goran.johansson@shiftit.se>
@@ -0,0 +1,30 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

Update the filename to todays date and then I think it's good to go 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed to 08-23

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: 0

Outside diff range, codebase verification and nitpick comments (1)
blog/2024-08-23-lawn-mower-activity-returning.md (1)

4-4: Remove quotes from the title.

The title should not use quotes for UI strings. Use bold instead if needed.

-title: "New returning type in LawnMowerActivity"
+title: New returning type in LawnMowerActivity

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @mikey0000 👍

@gjohansson-ST gjohansson-ST merged commit 90ce5bb into home-assistant:master Aug 23, 2024
4 checks passed
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.

4 participants