From aec0b612fdad1031f33f55140cb6cfccd93ec24a Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Tue, 19 Sep 2023 19:44:35 +0200 Subject: [PATCH] Align documented fan attributes with implementation (#1920) Co-authored-by: Martin Hjelmare Co-authored-by: Franck Nijhof --- docs/core/entity/fan.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/core/entity/fan.md b/docs/core/entity/fan.md index 9d6753a2..c5363405 100644 --- a/docs/core/entity/fan.md +++ b/docs/core/entity/fan.md @@ -13,14 +13,13 @@ Properties should always only return information from memory and not do I/O (lik | Name | Type | Default | Description | ---- | ---- | ------- | ----------- -| current_direction | str | `None` | Return the current direction of the fan | -| is_on | boolean | `None` |Return true if the entity is on | -| oscillating | boolean | None | Return true if the fan is oscillating | -| percentage | int | `None` | Return the current speed percentage. Must be a value between 0 (off) and 100 | -| speed_count | int | 100 | The number of speeds the fan supports | -| supported_features | int | 0 | Flag supported features | -| preset_mode | str | `None` | Return the current preset_mode. One of the values in `preset_modes` or `None` if no preset is active. | -| preset_modes | list | `None` | Get the list of available preset_modes. This is an arbitrary list of str and should not contain any speeds. | +| current_direction | str | None | `None` | The current direction of the fan. | +| is_on | bool | None | `None` | True if the fan is on. | +| oscillating | bool | None | `None` | True if the fan is oscillating. | +| percentage | int | None | `0` | The current speed percentage. Must be a value between 0 (off) and 100. | +| preset_mode | str | None | `None` | The current preset_mode. One of the values in `preset_modes` or `None` if no preset is active. | +| preset_modes | list[str] | None | `None` | The list of supported preset_modes. This is an arbitrary list of str and should not contain any speeds. | +| speed_count | `int` | 100 | The number of speeds the fan supports. | ### Preset Modes