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

Document new Time SMA Filter flag, update_by_time. #36181

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

dbrand666
Copy link
Contributor

@dbrand666 dbrand666 commented Dec 5, 2024

Proposed change

Document the new update_by_time flag for the Time SMA Filter. See home-assistant/core#131745

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

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration parameter, update_by_time, for filter sensors to enhance functionality and control.
  • Documentation

    • Updated documentation to include details on the update_by_time parameter, emphasizing its relevance and providing recommendations for optimal use.
    • Added a note regarding the behavior of the Time Simple Moving Average filter when input data remains constant.

@dbrand666 dbrand666 requested a review from dgomes as a code owner December 5, 2024 17:03
@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo 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 labels Dec 5, 2024
@home-assistant
Copy link

home-assistant bot commented Dec 5, 2024

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

Copy link

netlify bot commented Dec 5, 2024

Deploy Preview for home-assistant-docs failed.

Name Link
🔨 Latest commit ae000db
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6767471c710fa60008e9d4f8

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve updates to the documentation for the filter integration in Home Assistant. A new configuration parameter, update_by_time, has been introduced for filter sensors, allowing users to determine if the Time Simple Moving Average filter should update based on time intervals. The documentation has been enhanced to include details about this parameter, including its default value and recommendations for optimal use. The overall structure of the documentation remains unchanged, with the new parameter integrated into existing examples.

Changes

File Change Summary
source/_integrations/filter.markdown Added new parameter update_by_time for filter sensors, including its description, default value, and recommendations for use. Note added regarding the behavior of the Time Simple Moving Average filter based on input data changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FilterSensor
    participant TimeSimpleMovingAverage
    
    User->>FilterSensor: Configure filter with update_by_time
    FilterSensor->>TimeSimpleMovingAverage: Set update_by_time to true/false
    TimeSimpleMovingAverage->>FilterSensor: Update based on time intervals
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c595b9 and ae000db.

📒 Files selected for processing (1)
  • source/_integrations/filter.markdown (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/filter.markdown

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Outside diff range and nitpick comments (2)
source/_integrations/filter.markdown (2)

188-192: Fix typo in the Time SMA description

There's a typo in the word "general":

-input values don't change for a long period of time. In geenral, you probably want to
+input values don't change for a long period of time. In general, you probably want to

113-114: Remove trailing spaces

Please remove the trailing spaces from these lines to maintain consistent formatting.

🧰 Tools
🪛 Markdownlint (0.35.0)

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

(MD009, no-trailing-spaces)


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

(MD009, no-trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8d5c349 and c0facf3.

📒 Files selected for processing (1)
  • source/_integrations/filter.markdown (3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
source/_integrations/filter.markdown

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

(MD009, no-trailing-spaces)


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

(MD009, no-trailing-spaces)

🔇 Additional comments (1)
source/_integrations/filter.markdown (1)

60-60: LGTM: Good example of the new parameter usage

The example correctly demonstrates how to use the new update_by_time parameter with the recommended value of true.

Comment on lines 112 to 120
update_by_time:
description: This defaults to `false` for backward compatibility.
You probably want to set it to `true`. See [_time_simple_moving_average_]
(#time-simple-moving-average) filter.
required: false
type: bool
default: false
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix broken link in the parameter description

The link to the time_simple_moving_average section is broken due to an unexpected line break. Please fix the markdown link syntax:

-      You probably want to set it to `true`. See [_time_simple_moving_average_] 
-      (#time-simple-moving-average) filter.
+      You probably want to set it to `true`. See [_time_simple_moving_average_](#time-simple-moving-average) filter.
📝 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
update_by_time:
description: This defaults to `false` for backward compatibility.
You probably want to set it to `true`. See [_time_simple_moving_average_]
(#time-simple-moving-average) filter.
required: false
type: bool
default: false
update_by_time:
description: This defaults to `false` for backward compatibility.
You probably want to set it to `true`. See [_time_simple_moving_average_](#time-simple-moving-average) filter.
required: false
type: bool
default: false
🧰 Tools
🪛 Markdownlint (0.35.0)

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

(MD009, no-trailing-spaces)


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

(MD009, no-trailing-spaces)

@dbrand666
Copy link
Contributor Author

@coderabbitai full review

@gjohansson-ST gjohansson-ST removed the in-progress This PR/Issue is currently being worked on label Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.

2 participants