Update emulated_hue configuration variable style #6429
Conversation
| type: list | ||
| default: [script, scene] | ||
| expose_by_default: | ||
| description: "Whether or not entities should be exposed via the bridge by default instead of explicitly (see the ‘emulated_hue’ customization below). Warning: If you have a lot of devices (more than 49 total across all exposed domains), you should be careful with this option. Exposing more devices than Alexa supports can result in it not seeing any of them. If you are having trouble getting any devices to show up, try disabling this, and explicitly exposing just a few devices at a time to see if that fixes it." |
There was a problem hiding this comment.
Had to quote this due to special character in text ("Warning:")
There was a problem hiding this comment.
My apologies, @fredrikbaberg . I thought the quotes were going to be shown at the resulting page. Sorry you had to do unnecessary work.
There was a problem hiding this comment.
I understood the documentation as both being possible, but the quotes are required when there are control characters (https://developers.home-assistant.io/docs/en/documentation_standards.html). The example I started to look at used quotes for everything (and of course I can't find that now, so either I misread or it's been updated).
After your comment regarding quotes I'm only using them where required, and this is my interpretation of "add a note" (see above link to documentation standards).
There was a problem hiding this comment.
IMO the paragraph you provided only covers the immediate user's YAML config files, not the descriptions for internal use (like this). "Add a note" implies informing a user that if he does not quote particular values in his config, it may be invalid.
There was a problem hiding this comment.
Learning lot of new things this week, then I'll use quotes when needed in documentation.
You think the PR is OK as it is? Anything I should correct?
There was a problem hiding this comment.
TBH I still find documentation a little fuzzy.
Maybe content starting from line 123 may be embedded in the main part as it's done here. On the other hand, there it says that variable sensors is a map with keys such as friendly_name, friendly_name_template, etc, which, in YAML representation, would look like this (or am I missing something?):
sensors:
friendly_name: "Sun angle"
friendly_name_template: "{{ states.sun.sun.attributes.elevation }}"But it doesn't:
sensors:
solar_angle:
friendly_name: "Sun angle"
unit_of_measurement: 'degrees'
value_template: "{{ states.sun.sun.attributes.elevation }}"Also the standard says (since home-assistant/developers.home-assistant#105) that
If you use
map/listthen you need to definekeys:
But what if we use just a list of strings, like here (off_maps_to_on_domains variable)?
emulated_hue:
host_ip: 192.168.1.186
listen_port: 8300
advertise_ip: 10.0.0.10
advertise_port: 8080
off_maps_to_on_domains:
- script
- sceneWe don't need to specify any keys in that case.
|
@WofWca We have updated the documentation a little, to make it a little more consistent. This allows us to keep the PR's flowing. Thx 👍 |
|
@fredrikbaberg Thank you for this 👍 While there are some discussions on specific formatting (as discussed above), this is now "in-line" with the current documentation and therefore a step forward. Whatever the discussion changes to the "standards", we would have to update a large part of our documentation anyways. Happy Hacktoberfest 🎉 ../Frenck |
Description:
Update style of emulated_hue documentation to follow new configuration variables description.
Related to #6385.
Pull request in home-assistant (if applicable): home-assistant/home-assistant#
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.