mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Merge pull request #5039 from home-assistant/standard
Add details for values if the user should replace it (fixes #4999)
This commit is contained in:
commit
6a9c9d739d
@ -28,6 +28,8 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
|
||||
* Use `[string, int]` for configuration variables that accept multiple types.
|
||||
* Use YAML sequence syntax in the sample code if it is supported.
|
||||
* All examples should be formatted to be included in `configuration.yaml` unless explicitly stated.
|
||||
* Use capital letters and `_` to indicate that the value needs to be replaced. E.g., `api_key: YOUR_API_KEY` or `api_key: REPLACE_ME`.
|
||||
* If you know that the API key or value contains [control characters](https://en.wikipedia.org/wiki/YAML#Syntax), e.g., `#`, `[`, `?`, etc., wrap it in quotes and add a note.
|
||||
* Component and platform names should be a link to their respective documentation pages.
|
||||
|
||||
## {% linkable_title Templates %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user