Update Swiss Hydrological Data documentation #6535
Conversation
| @@ -13,15 +13,15 @@ ha_iot_class: "Cloud Polling" | |||
| ha_release: 0.22 | |||
| --- | |||
|
|
|||
| <p class='note warning'> | |||
| This sensor doesn't work at the moment due to changed by the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) to access the data. | |||
| <p class='note info'> | |||
There was a problem hiding this comment.
IIRC class='note' is enough.
|
|
||
| This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/). | ||
| <p class='note info'> |
| description: list of measurements you want to use. | ||
| required: true | ||
| type: list | ||
| deafult: |
There was a problem hiding this comment.
Typo: default. Also, default should have a value.
| description: list of measurements you want to use. | ||
| required: true | ||
| type: list | ||
| deafult: | ||
| {% endconfiguration %} |
There was a problem hiding this comment.
This is a list and that should have a keys attribute. You can use that attribute to list the possible measurement values.
|
|
||
| ## {% linkable_title Example %} | ||
| - temperature |
There was a problem hiding this comment.
Move this section into the keys second of the measurements configuration value.
| @@ -2,7 +2,7 @@ | |||
| layout: page | |||
| title: "Swiss Hydrological Data" | |||
| description: "Instructions on how to integrate hydrological data of Swiss waters within Home Assistant." | |||
| date: 2016-06-17 17:00 | |||
| date: 2018-10-05 12:00 | |||
There was a problem hiding this comment.
Please do not update the date. It marks the initial introduction.
|
I've got some feedback on the component itself. Therefore I will update fix the documentation as soon as I've found a solution for the addressed issues with the component! |
|
Thanks for letting us know @Bouni! |
|
Hold on sec, this PR depends on a parent PR. |
|
@frenck I've used current because the documentation says that updates of existing components should go into current, just documentation on new components should go into next. |
|
@Bouni I understand the confusion. Updates to the current release or documentation fixes go into the This ensures the docs & release are in sync (and matches). |
Description:
Pull request in home-assistant (if applicable): home-assistant/core#17166
Checklist:
nextis for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created againstcurrent.