Added mention about the colour of the data line in graphs for short- … #37587
Conversation
…and long-term data
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation in Changes
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/history.markdown (1)
47-47: Clarify compound adjective usage and data line color differentiation.
The new sentence clearly improves the explanation of how data is visualized. However, to fully align with the PR objectives and improve clarity, consider the following enhancements:
- Hyphenation: Change "long term" to "long-term" when used as a compound adjective (e.g., "long-term statistics table" and "long-term statistics data") per conventional language guidelines.
- Data Line Differentiation: The sentence states, "The detailed data will be shown with a darker line on graphs." To match the PR objective—which indicates a differentiation between short- and long-term data by color—explicitly mention that detailed (high-resolution, short-term) data is shown with a darker line, while the aggregated long-term data is displayed with a lighter line.
Below are sample diffs to address the hyphenation and to clarify the visual distinction:
-If you select a time frame that exceeds 10 days, the data is taken from the long term statistics table. 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. 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 in the recorder data, which shows the measured values at the sample rate defined for that sensor. The detailed (short-term) data will be shown with a darker line on graphs, while the aggregated long-term data will appear with a lighter line.This clarification will help users immediately understand the visual distinction between the two data sets.
🧰 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. The long term statist...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rom the long term statistics table. 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. The long term statist...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rom the long term statistics table. 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
…and long-term data
Proposed change
Mention of the color of the data lines in graphs (darker for short- and lighter for long-term data)
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit