jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-13 12:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing options (#109)

Browse Source 
* Add missing options

* Fix link
This commit is contained in:
Fabian Affolter 2018-10-04 09:04:21 +02:00 committed by GitHub
parent a14f7e7cb7
commit d75663199c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/documentation_create_page.md
View File

@ -89,7 +89,7 @@ required: inclusive #=> Inclusive
required: exclusive #=> Exclusive required: exclusive #=> Exclusive
required: any string here #=> Any string here required: any string here #=> Any string here
``` ```
- **`type:`**: The type of the variable. Allowed entries: `boolean`, `string`, `integer`, `time`, `template` or `map`/`list` (for a list of entries). For multiple possibilities use `[string, integer]`. If you use `map`/`list` then you need to define `keys:` (see the [`template` sensor](https://www.home-assistant.io/components/sensor.template/) for an example). - **`type:`**: The type of the variable. Allowed entries: `boolean`, `string`, `integer`, `time`, `template`, `device_class`, `icon` or `map`/`list` (for a list of entries). For multiple possibilities use `[string, integer]`. If you use `map`/`list` then you need to define `keys:` (see the [`template` sensor](https://www.home-assistant.io/components/sensor.template/) for an example).
- **`default:`**: The default value for the variable. - **`default:`**: The default value for the variable.
### Embedding Code ### Embedding Code

2
docs/documentation_standards.md
View File

@ -19,7 +19,7 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
* The **Configuration Variables** section must use the `{% configuration %}` tag. * The **Configuration Variables** section must use the `{% configuration %}` tag.
* Configuration variables must document the requirement status (`false` or `true`) * Configuration variables must document the requirement status (`false` or `true`)
* Configuration variables must document the default value, if any. * Configuration variables must document the default value, if any.
* Configuration variables must document the accepted value types (`string`, `boolean`, `integer`, `list`) * Configuration variables must document the accepted value types (see [Configuration variables details](documentation_create_page.md#configuration))
* For configuration variables that accept multiple types, separate the types with a comma (i.e. `string, int`). * For configuration variables that accept multiple types, separate the types with a comma (i.e. `string, int`).
* Use YAML sequence syntax in the sample code if it is supported. * 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. * All examples should be formatted to be included in `configuration.yaml` unless explicitly stated.