Skip to content

Update history.markdown #38860

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

Merged
merged 1 commit into from
May 5, 2025
Merged

Conversation

jackjourneyman
Copy link
Contributor

@jackjourneyman jackjourneyman commented May 3, 2025

Clarifies which sensors have long-term statistics

Proposed change

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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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

  • Documentation
    • Clarified that long term statistics are only saved for sensors with a state_class of measurement, total, or total_increasing when viewing data for periods longer than 10 days.

Clarifies which sensors have long-term statistics
@jackjourneyman jackjourneyman requested a review from a team as a code owner May 3, 2025 10:37
@home-assistant home-assistant bot added the current This PR goes into the current branch label May 3, 2025
Copy link

netlify bot commented May 3, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 45069aa
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6815f1fad14d110008e26116
😎 Deploy Preview https://deploy-preview-38860--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.

Copy link
Contributor

coderabbitai bot commented May 3, 2025

📝 Walkthrough

Walkthrough

The documentation for the History integration was updated to clarify that long term statistics are only saved for sensors with a state_class of measurement, total, or total_increasing. This clarification was added to the section explaining how data is sourced when a time frame exceeding 10 days is selected. No changes were made to the technical implementation, public interfaces, or code; only the documentation was modified.

Changes

File(s) Change Summary
source/_integrations/history.markdown Updated documentation to specify that long term statistics are saved only for certain state_class values (measurement, total, or total_increasing).

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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

🧹 Nitpick comments (1)
source/_integrations/history.markdown (1)

47-47: Use hyphens for compound adjectives and format state_class values consistently
The phrase “long term statistics” should be hyphenated as “long-term statistics” throughout. Also, wrap the sensor state_class values in backticks and include an Oxford comma for clarity:

- If you select a time frame that exceeds 10 days, the data is taken from the long term statistics table. Long term statistics are saved for sensors with a state_class of measurement, total or total_increasing. The long term statistics data is sampled and averaged once per hour, to save storage. Therefore, the values might look different from what you see from the recorder data, which shows the measured values at the sample rate defined for that sensor. The detailed data will be shown with a darker line on graphs.
+ If you select a time frame that exceeds 10 days, the data is taken from the long-term statistics table. Long-term statistics are saved for sensors with a `state_class` of `measurement`, `total`, or `total_increasing`. The long-term statistics data is sampled and averaged once per hour to save storage. Therefore, the values might look different from what you see from the recorder data, which shows the measured values at the sample rate defined for that sensor. The detailed data will be shown with a darker line on graphs.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eds 10 days, the data is taken from the long term statistics table. Long term statistics ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...en from the long term statistics table. Long term statistics are saved for sensors with a...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...urement, total or total_increasing. The long term statistics data is sampled and averaged...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 696a1f3 and 45069aa.

📒 Files selected for processing (1)
  • source/_integrations/history.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/history.markdown

[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eds 10 days, the data is taken from the long term statistics table. Long term statistics ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...en from the long term statistics table. Long term statistics are saved for sensors with a...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...urement, total or total_increasing. The long term statistics data is sampled and averaged...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/history.markdown (1)

47-47: Clarification improves user guidance
The added sentence makes it clear which sensors support long-term statistics and how that data is sampled when viewing periods over 10 days. This enhances the user’s understanding of the History integration.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...eds 10 days, the data is taken from the long term statistics table. Long term statistics ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...en from the long term statistics table. Long term statistics are saved for sensors with a...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...urement, total or total_increasing. The long term statistics data is sampled and averaged...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @jackjourneyman 👍

@c0ffeeca7 c0ffeeca7 merged commit 5e147e0 into home-assistant:current May 5, 2025
7 checks passed
@jackjourneyman jackjourneyman deleted the patch-3 branch May 5, 2025 09:48
@github-actions github-actions bot locked and limited conversation to collaborators May 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants