Skip to content

Improve deCONZ switch platform documentation#5986

Merged
frenck merged 1 commit intohome-assistant:nextfrom
Kane610:deconz-support-for-sirens
Aug 13, 2018
Merged

Improve deCONZ switch platform documentation#5986
frenck merged 1 commit intohome-assistant:nextfrom
Kane610:deconz-support-for-sirens

Conversation

@Kane610
Copy link
Copy Markdown
Member

@Kane610 Kane610 commented Aug 10, 2018

Description:

Pull request in home-assistant (if applicable): home-assistant/core#15896

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.

@ghost ghost assigned Kane610 Aug 10, 2018
@ghost ghost added the ready-for-review This PR needs to be reviewed label Aug 10, 2018
@frenck frenck added new-feature This PR adds documentation for a new Home Assistant feature to an existing integration next This PR goes into the next branch has-parent This PR has a parent PR in another repo labels Aug 10, 2018

Note that devices in the switch platform identify as lights, so there is a manually curated list that defines which "lights" are switches.

The `Entity Id` names will be `switch.device_name`, where `device_name` is defined in deCONZ.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do we refer to entity_id as Entity Idelsewhere in the docs?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It seems to vary

Copy link
Copy Markdown
Member

@frenck frenck Aug 13, 2018

Choose a reason for hiding this comment

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

I would suggest is replacing it with either:

"The entity ID names will"
OR
"The entity_id names will".

I'll guess the latter is more fitting, as it matches the rest of the sentence.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Then for consistencies sake I should do the same thing in all deconz pages.

Is it ok if I do that in a clean up PR?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, I guess it won't hurt that much now at this moment.
Looking forward to the PR 👍

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You'll have it during this week

@frenck frenck self-assigned this Aug 13, 2018
@frenck frenck added this to the 0.76 milestone Aug 13, 2018
@frenck frenck merged commit 2ed664b into home-assistant:next Aug 13, 2018
@ghost ghost removed the ready-for-review This PR needs to be reviewed label Aug 13, 2018
@frenck frenck removed their assignment Aug 13, 2018
@balloob balloob added the cherry-picked This PR has been manually picked and merged into the current branch label Aug 14, 2018
@Kane610 Kane610 deleted the deconz-support-for-sirens branch August 23, 2018 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-picked This PR has been manually picked and merged into the current branch has-parent This PR has a parent PR in another repo new-feature This PR adds documentation for a new Home Assistant feature to an existing integration next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants