-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
Use the new style for configuration variables description #6385
Comments
Should we open individual PRs for each page changed? |
Yes, please or at least don't add 50 platforms to one Pull Request. If you want you can combine the changes for a component and its platforms. If the Pull Requests are small it easier to spot for others which docs are in progress or already done. |
I think that the documentation, in accordance to which these changes must be done, is a bit outdated. |
* Style for configuration variables description Change to new style for configuration variables description (#6385). * Updated configuration example * Corrected from to be required variable. * Removed quote of decsription text. * Corrected incorrect linebreak. * Minor change * Change to list
@WofWca, Doc were updated. Please feel free to improve them if you think that something is not clear.. Thanks for the feedback, BTW. |
Change to new style for configuration variables description. Related to home-assistant#6385.
Change to new style for configuration variables description. Related to #6385.
Fixes home-assistant#6385 for Abode
Per home-assistant#6385 updating the configuration description.
After PR #7154 all the pages are done 😄 |
How should a configuration variable be described when it represents an enum (a string with only several acceptable values in my case)? |
@farmio For YAML, it is still just a string... |
The last PR, #7154 has been finished and merged. Therefore, this issue can be closed! 🎉 Thank you all for your contributions. 👍 ❤️ A major shoutout to @klaasnicolaas who has done an impressive amount of PRs on this issue!🥇 |
A while back an advance way to describe the configuration variables was introduced.
At the moment not all platform and component documentation is ported to the new style.
This the tracking issue. Please don't close but add as a reference to your Pull request.
The text was updated successfully, but these errors were encountered: