Document update entity's display_precision property #2414

emontnemery · 2024-10-22T06:04:48Z

Proposed change

Document update entity's display_precision property

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: Allow update entities to report progress as a float core#128930

Summary by CodeRabbit

New Features
- Introduced a new property, display_precision, to enhance update progress display with customizable decimal precision.
- Updated the update_percentage property to accept both int and float types for improved flexibility.
Documentation
- Updated the documentation to reflect the addition of the display_precision property and changes to the update_percentage property.

coderabbitai · 2024-10-22T06:06:39Z

📝 Walkthrough

Walkthrough

The document docs/core/entity/update.md has been updated to include a new property called display_precision. This property is of type int with a default value of 0, and it specifies the number of decimal digits for displaying update progress. Additionally, the update_percentage property has been modified to accept both int and float types. No other properties or sections in the document were modified, maintaining the overall structure and existing functionality.

Changes

File	Change Summary
docs/core/entity/update.md	Added property `display_precision: int = 0` and updated `update_percentage` to accept `int, float`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UpdateEntity

    User->>UpdateEntity: Request update progress
    UpdateEntity-->>User: Display progress with display_precision

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1b533f4 and 597e391.

📒 Files selected for processing (1)

docs/core/entity/update.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs/core/entity/update.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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/core/entity/update.md (1)

27-27: LGTM! Consider adding a usage example.

The addition of the display_precision property is well-documented and consistent with the existing format. It clearly explains the purpose and type of the property.

To further enhance the documentation, consider adding a brief usage example to illustrate how this property affects the display of update progress. This could help developers better understand its practical application.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7a11096 and 1b533f4.

📒 Files selected for processing (1)

docs/core/entity/update.md (1 hunks)

🧰 Additional context used

MartinHjelmare

We should update the type for update_percentage, right?

home-assistant · 2024-10-24T20:39:34Z

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

Learn more about our pull request process.

MartinHjelmare

Can we merge? Is there anything else left to do before we write a dev blog about this?

emontnemery · 2024-10-26T07:52:19Z

Can we merge? Is there anything else left to do before we write a dev blog about this?

I think we should not merge until there's a dev blog PR so we don't forget 🙈

Document display_precision property

1b533f4

home-assistant bot added the hacktoberfest label Oct 22, 2024

emontnemery mentioned this pull request Oct 22, 2024

Allow update entities to report progress as a float home-assistant/core#128930

Merged

19 tasks

coderabbitai bot reviewed Oct 22, 2024

View reviewed changes

MartinHjelmare requested changes Oct 24, 2024

View reviewed changes

home-assistant bot marked this pull request as draft October 24, 2024 20:39

Update update.md

597e391

MartinHjelmare approved these changes Oct 25, 2024

View reviewed changes

emontnemery marked this pull request as ready for review October 26, 2024 07:51

home-assistant bot requested a review from MartinHjelmare October 26, 2024 07:51

emontnemery marked this pull request as draft October 26, 2024 07:52

emontnemery mentioned this pull request Oct 30, 2024

Add progress support to MQTT update platform home-assistant/core#129468

Merged

19 tasks

frenck added the parent-merged label Nov 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document update entity's display_precision property #2414

Document update entity's display_precision property #2414

emontnemery commented Oct 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 22, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

MartinHjelmare left a comment

home-assistant bot commented Oct 24, 2024

MartinHjelmare left a comment

emontnemery commented Oct 26, 2024

Document update entity's display_precision property #2414

Are you sure you want to change the base?

Document update entity's display_precision property #2414

Conversation

emontnemery commented Oct 22, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Summary by CodeRabbit

coderabbitai bot commented Oct 22, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

home-assistant bot commented Oct 24, 2024

MartinHjelmare left a comment

Choose a reason for hiding this comment

emontnemery commented Oct 26, 2024

emontnemery commented Oct 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 22, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)