Explain use of collection_key for energy cards
#37335
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request adds a new documentation section titled “Using Multiple Collections” to the energy cards documentation. This section explains how to configure energy cards to support multiple date selections by introducing a new YAML variable, collection_key, which must begin with the prefix "energy_". An example is provided, and the documentation clarifies that any collection_key not following this naming convention will result in an error. This update does not change the existing functionality. Changes
Tip 🌐 Web search-backed reviews and chat
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_dashboards/energy.markdown (1)
238-242: Documentation Clarity forcollection_keySectionThe new "Using Multiple Collections" section clearly explains how users can link energy cards to distinct date selections using the
collection_keyvariable. To further polish the prose, consider a minor grammatical tweak on line 242. Instead of:All energy cards support use of
collection_keyoption.it might read better as:
All energy cards support the use of the
collection_keyoption.This small change improves clarity and conforms to standard English grammar.
[minor]
-All energy cards support use of `collection_key` option. +All energy cards support the use of the `collection_key` option.🧰 Tools
🪛 LanguageTool
[uncategorized] ~242-~242: You might be missing the article “the” here.
Context: ...rror). All energy cards support use ofcollection_keyoption. ### Examples Ex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_dashboards/energy.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_dashboards/energy.markdown
[uncategorized] ~242-~242: You might be missing the article “the” here.
Context: ...rror). All energy cards support use of collection_key option. ### Examples Ex...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~244-~244: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...rt use of collection_key option. ### Examples Example view with multiple collections: ```yam...
(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
source/_dashboards/energy.markdown
244-244: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (1)
source/_dashboards/energy.markdown (1)
244-261: Markdown Formatting and Example ClarificationThe examples provided from line 244 onward are very helpful for illustrating how a multi-collection view is configured. A couple of formatting improvements are recommended:
- Ensure that headings (e.g., "### Examples") are surrounded by a blank line to satisfy markdownlint guidelines (MD022).
- The introductory phrase "Example view with multiple collections:" is useful, but double-check that the text does not inadvertently repeat any verb or description from the title.
If needed, add a blank line above the "### Examples" heading for better readability.
[minor]
[markdown]🧰 Tools
🪛 LanguageTool
[grammar] ~244-~244: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...rt use ofcollection_keyoption. ### Examples Example view with multiple collections: ```yam...(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
244-244: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_dashboards/energy.markdown (2)
237-240: Improve documentation clarity and grammar in the new section header and description.
The new "Using Multiple Collections" section is a valuable addition that clearly explains how to link energy cards to separate date selections. To further enhance clarity, consider rephrasing the sentence on line 240 from:
All energy cards support use ofcollection_keyoption.
to:
All energy cards support thecollection_keyoption.This small change resolves the repeated verb issue flagged by static analysis and improves readability. Also, ensure that headings are surrounded by blank lines (per markdownlint MD022) if not already enforced by your markdown formatter.
-All energy cards support use of `collection_key` option. +All energy cards support the `collection_key` option.
241-255: Enhance YAML example clarity and inline commentary.
The provided YAML example clearly demonstrates how to configure multiple collections by linking cards via thecollection_key. To further aid readers, consider adding or refining inline comments so that the association between each energy card and its corresponding date selection is unmistakable. For example, you might clarify that the first energy-date-selection (without a specified collection_key) serves as the default, while the second (withcollection_key: energy_2) enables an alternative date selection.A potential refinement could be:
cards: - - type: energy-date-selection - - type: energy-date-selection - collection_key: energy_2 - # This card is linked to the first (default) date selection - - type: energy-usage-graph - # This card is linked to the second date selection - - type: energy-usage-graph - collection_key: energy_2 + - type: energy-date-selection # Default date selection + - type: energy-date-selection # Secondary date selection + collection_key: energy_2 + - type: energy-usage-graph # Linked to the default date selection + - type: energy-usage-graph # Linked to the secondary date selection + collection_key: energy_2Feel free to adjust the inline comments as needed to match the intended guidance.
🧰 Tools
🪛 LanguageTool
[grammar] ~244-~244: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...rt use ofcollection_keyoption. ### Examples Example view with multiple collections: ```yam...(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
244-244: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_dashboards/energy.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_dashboards/energy.markdown
[grammar] ~244-~244: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...rt use of collection_key option. ### Examples Example view with multiple collections: ```yam...
(REPEATED_VERBS)
🪛 markdownlint-cli2 (0.17.2)
source/_dashboards/energy.markdown
244-244: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
⏰ 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
Proposed change
This option is currently undocumented.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit