Skip to content

Update Toon docs #3771

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

Merged
merged 4 commits into from
Oct 26, 2017
Merged

Update Toon docs #3771

merged 4 commits into from
Oct 26, 2017

Conversation

boltgolt
Copy link
Contributor

Description:

Added more information to the Toon docs, and updated the titles so the components don't all show up as "Toon" in the component search.

@boltgolt
Copy link
Contributor Author

I see @fabaff also noticed the title issue and fixed it here, but i think these titles are a lot more discriptive of what the component actially does.

@frenck frenck self-requested a review October 25, 2017 13:03
@frenck frenck added Fix/Formatting/Language/Spelling Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Oct 25, 2017
@@ -13,6 +13,15 @@ logo: toon.png
ha_iot_class: "Cloud Polling"
---

The `toon` climate platform allows you to interact with your Toon device.
The `toon` climate platform allows you to interact with your Toon thermostat. For compatibility reasons the states are different from the normal "Toon programma's", they are mapped as follows:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the addition but maybe we should keep the documentation as English as possible.
I like to suggest: For compatibility reasons, the states in Home Assistant are different from the states displayed on your Toon device and are mapped as follows:

description: "Instructions how to integrate Toon Climate devices within Home Assistant."
date: 2017-10-21 12:00
title: "Toon Thermostat"
description: "Instructions how to integrate Toon Thermostats within Home Assistant."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thermostats is not part of the title or product name and should be written lower caps.

description: "Instructions how to integrate Toon Climate devices within Home Assistant."
date: 2017-10-21 12:00
title: "Toon Smart Plugs"
description: "Instructions how to integrate Toon Smart Plugs within Home Assistant."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Smart Plugs is not part of the product name and should be written in lower caps.

@frenck
Copy link
Member

frenck commented Oct 25, 2017

@boltgolt, Good job on the additions, nevertheless I have some small advise and concerns. Could you take a look?

@boltgolt
Copy link
Contributor Author

@frenck Thanks for the quick review, i pushed the changes as suggested.

@fabaff
Copy link
Member

fabaff commented Oct 26, 2017

Those changes should have been made against current. #3752 introduced some changes.

@fabaff fabaff merged commit ddbbae9 into home-assistant:next Oct 26, 2017
fabaff pushed a commit that referenced this pull request Oct 26, 2017
* Updates to Toon docs

* Fixed typo

* Implemented suggested fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants