-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
Update history.markdown #38860
Conversation
Clarifies which sensors have long-term statistics
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the History integration was updated to clarify that long term statistics are only saved for sensors with a Changes
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 formatstate_class
values consistently
The phrase “long term statistics” should be hyphenated as “long-term statistics” throughout. Also, wrap the sensorstate_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
📒 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)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @jackjourneyman 👍
Clarifies which sensors have long-term statistics
Proposed change
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit