Improve Tankerkoenig docs #38662
Improve Tankerkoenig docs #38662
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant TankerkoenigAPI
User->>HomeAssistant: Initiate tankerkoenig integration setup
HomeAssistant->>User: Request API key and configuration details
User->>HomeAssistant: Provide API key, location, radius, etc.
HomeAssistant->>TankerkoenigAPI: Fetch station data (every 30 minutes)
TankerkoenigAPI-->>HomeAssistant: Return station and fuel price data
HomeAssistant->>User: Create sensor and binary sensor entities per station
User->>HomeAssistant: View/update fuel prices and station statuses
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:
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 (5)
source/_integrations/tankerkoenig.markdown (5)
25-25: Grammar: use correct verb form for setting up automations
“...and setup automations” should use the verb phrase “set up automations” (two words) to avoid confusion with the noun “setup.”
27-29: Typographical: add comma after introductory clause
In the sentence “To use this integration you need an API key…”, add a comma after “integration” for clarity:
To use this integration, you need an API key from tankerkoenig.🧰 Tools
🪛 LanguageTool
[typographical] ~29-~29: It seems that a comma is missing.
Context: ...rmation. ## Prerequisites To use this integration you need an API key from tankerkoenig. ...(IN_ORDER_TO_VB_COMMA)
33-33: Grammar: refine verb form in important note
Change “If you consider to define a custom polling interval” to “If you consider defining a custom polling interval” for more natural English.🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
38-49: Grammar: correct typos in configuration descriptions
- “were to search” → “where to search”
- “et during onboarding” → “set during onboarding”
These small fixes will improve readability in the config parameter descriptions.
51-56: Reduce duplication in option flow configuration
You’ve repeated the “Stations” selection under the option flow. Consider consolidating or distinguishing these blocks:
- Use a dedicated
configuration_optionsmacro for runtime options (instead ofconfiguration_basic), or- Add a header clarifying this is for post‑setup options.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tankerkoenig.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/tankerkoenig.markdown
[typographical] ~29-~29: It seems that a comma is missing.
Context: ...rmation. ## Prerequisites To use this integration you need an API key from tankerkoenig. ...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~33-~33: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[grammar] ~63-~63: The singular determiner ‘this’ may not agree with the plural noun ‘integrations’. Did you mean “these”?
Context: ...ankerkoenig.de). ## Provides entities This integrations provides a set of {% term ...
(THIS_NNS)
[grammar] ~64-~64: Consider using the singular form after the singular determiner “This”.
Context: ...koenig.de). ## Provides entities This integrations provides a set of {% term "Binary senso...
(AGREEMENT_SENT_START)
⏰ 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 (2)
source/_integrations/tankerkoenig.markdown (2)
19-21: Validation of related documentation link
The newly addedrelatedsection correctly points to the common‑tasks guide for defining a custom polling interval and uses a meaningful title. Ensure that the path/common-tasks/general/#defining-a-custom-polling-intervalaligns with the actual URL structure in the docs.
36-36: Configuration flow include looks good
The inclusion ofintegrations/config_flow.mdaligns with other integrations and clearly injects the setup flow instructions.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
source/_integrations/tankerkoenig.markdown (5)
25-25: Use “set up” (verb) instead of “setup”
In this context “set up automations” (two words) is the correct verb form.Suggested diff:
-The `tankerkoenig` integration allows you to monitor the fuel prices with [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and setup automations based on the information. +The `tankerkoenig` integration allows you to monitor fuel prices via [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and set up automations based on that information.
29-29: Add missing comma for clarity
Insert a comma after “integration” to improve readability.Suggested diff:
-To use this integration you need an API key from tankerkoenig. +To use this integration, you need an API key from tankerkoenig.🧰 Tools
🪛 LanguageTool
[typographical] ~29-~29: It seems that a comma is missing.
Context: ...rmation. ## Prerequisites To use this integration you need an API key from tankerkoenig. ...(IN_ORDER_TO_VB_COMMA)
33-33: Use the gerund form “consider defining”
Replace “consider to define” with “consider defining” for correct English idiom.Suggested diff:
-If you consider to [define a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval), then please keep in mind that requests should be limited to less than once every 5 minutes. +If you consider defining a [custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval), please keep in mind that requests should be limited to less than once every 5 minutes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
57-57: Correct typo “Weather” → “Whether”
Change to “Whether to show the station sensors on the map or not.”Suggested diff:
-Show stations on map: - description: "Weather to show the station sensors on the map or not." +Show stations on map: + description: "Whether to show the station sensors on the map or not."
66-66: Fix subject‑verb agreement
Change “This integrations provides” → “This integration provides”.Suggested diff:
-This integrations provides a set of {% term "Binary sensor" %} and {% term Sensor %} entities for each selected gas station. +This integration provides a set of {% term "Binary sensor" %} and {% term Sensor %} entities for each selected gas station.🧰 Tools
🪛 LanguageTool
[grammar] ~66-~66: Consider using the singular form after the singular determiner “This”.
Context: ...koenig.de). ## Provides entities This integrations provides a set of {% term "Binary senso...(AGREEMENT_SENT_START)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tankerkoenig.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/tankerkoenig.markdown
[typographical] ~29-~29: It seems that a comma is missing.
Context: ...rmation. ## Prerequisites To use this integration you need an API key from tankerkoenig. ...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~33-~33: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[grammar] ~65-~65: The singular determiner ‘this’ may not agree with the plural noun ‘integrations’. Did you mean “these”?
Context: ...ankerkoenig.de). ## Provides entities This integrations provides a set of {% term ...
(THIS_NNS)
[grammar] ~66-~66: Consider using the singular form after the singular determiner “This”.
Context: ...koenig.de). ## Provides entities This integrations provides a set of {% term "Binary senso...
(AGREEMENT_SENT_START)
⏰ 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/tankerkoenig.markdown (1)
19-21: Front matterrelatedentry looks good
The newrelatedkey is valid YAML and correctly links to the custom polling‑interval docs.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/tankerkoenig.markdown (1)
44-44: Fix typo in location description
The word “et” should be “set” and casing of “Home” can be downcased. This duplicates an earlier suggestion.- … defaults to the location of your Home which was et during … + … defaults to the location of your home which was set during …
🧹 Nitpick comments (4)
source/_integrations/tankerkoenig.markdown (4)
25-25: Refine introductory sentence grammar
Change “setup automations” (noun) to “set up automations” (verb) and consider dropping “the” before “fuel prices” for smoother flow.
Example:- monitor the fuel prices … and setup automations + monitor fuel prices … and set up automations
29-29: Add missing comma after introductory clause
Insert a comma after “To use this integration” to correct the run‑on sentence.- To use this integration you need an API key … + To use this integration, you need an API key …🧰 Tools
🪛 LanguageTool
[typographical] ~29-~29: It seems that a comma is missing.
Context: ...rmation. ## Prerequisites To use this integration you need an API key from tankerkoenig. ...(IN_ORDER_TO_VB_COMMA)
33-33: Use correct verb form
Replace “If you consider to define” with “If you consider defining” or “If you want to define” for proper English usage.- If you consider to [define a custom polling interval] + If you consider defining [a custom polling interval]🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
46-46: Standardize unit formatting
Recommend adding a space between the number and unit (2 km) for consistency with other docs.- (_default: 2km_) + (_default: 2 km_)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tankerkoenig.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/tankerkoenig.markdown
[typographical] ~29-~29: It seems that a comma is missing.
Context: ...rmation. ## Prerequisites To use this integration you need an API key from tankerkoenig. ...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~33-~33: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[grammar] ~65-~65: The singular determiner ‘this’ may not agree with the plural noun ‘integrations’. Did you mean “these”?
Context: ...ankerkoenig.de). ## Provides entities This integrations provides a set of {% term ...
(THIS_NNS)
[grammar] ~66-~66: Consider using the singular form after the singular determiner “This”.
Context: ...koenig.de). ## Provides entities This integrations provides a set of {% term "Binary senso...
(AGREEMENT_SENT_START)
⏰ 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 (4)
source/_integrations/tankerkoenig.markdown (4)
19-21: Approve addition of the related section
The newrelatedfront matter neatly links to the common task on defining a custom polling interval, improving cross‑reference within the docs.
36-36: Approve inclusion of the config flow snippet
Embedding theintegrations/config_flow.mdtemplate ensures consistent configuration instructions across integrations.
38-38: Approve use ofconfiguration_basicdirective
Theconfiguration_basicblock clearly organizes key setup parameters for users.
48-48: Approve stations description
The “Select the gas stations you want to add to Home Assistant” description is clear and concise.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/tankerkoenig.markdown (1)
45-46: Duplicate fix for the Location description typo.
The phrase “was et during” still contains the typo flagged earlier; it should read “was set during.”- description: "Pick the location where to search for gas stations (_defaults to the location of your Home which was et during [onboarding](/getting-started/onboarding)_)" + description: "Pick the location where to search for gas stations (_defaults to the location of your home which was set during [onboarding](/getting-started/onboarding))_"
🧹 Nitpick comments (6)
source/_integrations/tankerkoenig.markdown (6)
25-25: Use the correct verb form “set up”.
In the intro sentence, change “and setup automations” → “and set up automations” to use “set up” as a verb.-The `tankerkoenig` integration allows you to monitor the fuel prices with [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and setup automations based on the information. +The `tankerkoenig` integration allows you to monitor the fuel prices with [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and set up automations based on the information.
29-31: Fix trailing space and ensure blank lines around lists.
Line 29 ends with an extra space, and list items are more readable with blank lines before/after. Consider:-To use this integration, you need an API key from tankerkoenig. +To use this integration, you need an API key from tankerkoenig. +1. Go to [tankerkoenig API](https://creativecommons.tankerkoenig.de) and in the top right, select **API‑KEY**. +2. Fill out the form and request a free API key.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
29-29: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
30-30: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
35-35: Improve phrasing of the conditional clause.
The phrase “If you consider to define a custom polling interval” is awkward. Use a gerund or rephrase:-If you consider to [define a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval), then please keep in mind that requests should be limited to less than once every 5 minutes. +When defining a custom polling interval, please keep in mind that requests should be limited to less than once every 5 minutes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
40-44: Standardize “API key” capitalization and style.
The description uses “API‑KEY”; for consistency, use “API key” (lowercase “key”) and remove underscores around the link:-API Key: - description: "The tankerkoenig API-KEY to be used (_see [Prerequisites](#prerequisites)_)." +API key: + description: "The tankerkoenig API key to be used (see [Prerequisites](#prerequisites))."Also consider clarifying the default behavior (if any) for “Region name.”
53-61: Option flow block and descriptions.
Theoption_flow.mdinclude is correct. However, in the “Show stations on map” description, “Weather” should be “Whether”:- description: "Weather to show the station sensors on the map or not." + description: "Whether to show the station sensors on the map or not."
66-69: Fix pluralization in “Provides entities”.
Change “This integrations provides” to the singular:-This integrations provides a set of {% term "Binary sensor" %} and {% term Sensor %} entities for each selected gas station. +This integration provides a set of {% term "Binary sensor" %} and {% term Sensor %} entities for each selected gas station.🧰 Tools
🪛 LanguageTool
[grammar] ~67-~67: The singular determiner ‘this’ may not agree with the plural noun ‘integrations’. Did you mean “these”?
Context: ...ankerkoenig.de). ## Provides entities This integrations provides a set of {% term ...(THIS_NNS)
[grammar] ~68-~68: Consider using the singular form after the singular determiner “This”.
Context: ...koenig.de). ## Provides entities This integrations provides a set of {% term "Binary senso...(AGREEMENT_SENT_START)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tankerkoenig.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/tankerkoenig.markdown
[uncategorized] ~35-~35: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e issued otherwise. If you consider to [define a custom polling interval](/common-task...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[grammar] ~67-~67: The singular determiner ‘this’ may not agree with the plural noun ‘integrations’. Did you mean “these”?
Context: ...ankerkoenig.de). ## Provides entities This integrations provides a set of {% term ...
(THIS_NNS)
[grammar] ~68-~68: Consider using the singular form after the singular determiner “This”.
Context: ...koenig.de). ## Provides entities This integrations provides a set of {% term "Binary senso...
(AGREEMENT_SENT_START)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/tankerkoenig.markdown
29-29: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
30-30: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ 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 (4)
source/_integrations/tankerkoenig.markdown (4)
19-21: Verify “related” block placement and formatting.
The newrelatedentry appears correctly indented within the frontmatter and follows the pattern used in other integrations.
27-27: Heading is correctly added.
The new “## Prerequisites” section aligns with the structure of other integration docs.
38-39: Include ofconfig_flow.mdis correct.
This matches the pattern for documenting the config flow across Home Assistant integrations.
47-50: Configuration parameters look good.
The “Search radius” and first “Stations” descriptions are clear and aligned with other integration docs.
Proposed change
This improves the Tankerkoening docs by
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit