Update lawn-mower.md with returning state

mikey0000 commented 3 weeks ago

Update lawn mower state with returning

core: https://github.com/home-assistant/core/pull/124261 architecture: https://github.com/home-assistant/architecture/discussions/1123 frontend: https://github.com/home-assistant/frontend/pull/21740

Proposed change

Type of change

[ ] Document existing features within Home Assistant
[x] 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

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.

coderabbitai[bot] commented 3 weeks ago

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) ```mermaid 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 ```

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 4b030e9d62f20dd7eee18821acd4c8aa53fdaf43 and 11d9cc7d1d2f6a6b1be42f638ec94fe46f63d3bb.

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

gjohansson-ST commented 3 weeks ago

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

mikey0000 commented 3 weeks ago

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

Done.

home-assistant / developers.home-assistant