Skip to content

Remote control updates #3997

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 5 commits into from
Nov 20, 2017

Conversation

amelchio
Copy link
Contributor

@amelchio amelchio commented Nov 16, 2017

Description:

  • Remove obsolete mentions of sync (moved to Harmony) and device (is now optional) from remote, remote.apple_tv and remote.itach.
  • Document all service data attributes for Harmony remote.
  • Cut down on complex Harmony examples that confuse rather than help.

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

@amelchio amelchio changed the base branch from next to current November 18, 2017 22:57
MartinHjelmare
MartinHjelmare previously approved these changes Nov 19, 2017
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Maybe you could keep the long example but mark it as advanced? I'm ok with removing it though.

@amelchio
Copy link
Contributor Author

I know it feels bad to remove a big chunk of work but in this context I find it confusing. I believe the platform documentation should explain the platform and not teach how to combine things, we have other resources for that.

I considered moving it to the Cookbook but there are already similar examples, for example here.


| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Only act on specific remote. Else targets all.
Copy link
Member

Choose a reason for hiding this comment

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

Missing determiner: on a specific remote
Use comma: remote, else target all


| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Only act on specific remote. Else targets all.
Copy link
Member

Choose a reason for hiding this comment

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

Missing determiner: on a specific remote
Use comma: remote, else target all


| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Only act on specific remote. Else targets all.
Copy link
Member

Choose a reason for hiding this comment

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

Missing determiner: on a specific remote
Use comma: remote, else target all

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Only act on specific remote. Else targets all.
| `device` | no | Device ID to send command to.
Copy link
Member

Choose a reason for hiding this comment

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

Missing determiner: to send the command to


| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Only act on specific remote. Else targets all.
Copy link
Member

Choose a reason for hiding this comment

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

Missing determiner: on a specific remote
Use comma: remote, else target all

@frenck
Copy link
Member

frenck commented Nov 20, 2017

@amelchio Reviewed your PR and found a couple of tiny spelling/grammar things. Could you please take a look?

@frenck frenck removed their assignment Nov 20, 2017
@amelchio
Copy link
Contributor Author

@frenck Thanks. I fixed those now, also in the component doc where I had copied it from :)

@frenck
Copy link
Member

frenck commented Nov 20, 2017

@amelchio Even better! Thank you for this 🏅

@amelchio amelchio merged commit 6a49dae into home-assistant:current Nov 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants