add documentation for !remove (#3406)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Subhash Chandra 2023-12-06 06:34:20 +05:30 committed by GitHub
parent 2bdece17dd
commit bb2a740d8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions

View File

@ -548,6 +548,28 @@ For example to set a specific update interval on a common uptime sensor that is
- id: !extend uptime_sensor
update_interval: 10s
Remove
------
To remove existing entries from included configurations ``!remove [config_id]`` can be used, where ``config_id`` is the ID of the entry to modify.
For example to remove a common uptime sensor that is shared between configurations:
.. code-block:: yaml
packages:
common: !include common.yaml
sensor:
- id: !remove uptime_sensor
To remove captive portal for a specific device:
.. code-block:: yaml
packages:
common: !include common.yaml
captive_portal: !remove
See Also
--------