From 19d12716ef98a3739abd670962648f12ea18ba16 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 12 Feb 2016 08:21:39 +0100 Subject: [PATCH] Update docstrings --- homeassistant/components/garage_door/__init__.py | 6 +++--- homeassistant/components/garage_door/demo.py | 3 +-- homeassistant/components/garage_door/wink.py | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/homeassistant/components/garage_door/__init__.py b/homeassistant/components/garage_door/__init__.py index 705b4ce547e..f49d520fc7d 100644 --- a/homeassistant/components/garage_door/__init__.py +++ b/homeassistant/components/garage_door/__init__.py @@ -1,12 +1,11 @@ """ homeassistant.components.garage_door -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Component to interface with garage doors that can be controlled remotely. For more details about this component, please refer to the documentation at https://home-assistant.io/components/garage_door/ """ - import logging import os @@ -84,7 +83,7 @@ def setup(hass, config): class GarageDoorDevice(Entity): - """ Represents a garage door within Home Assistant. """ + """ Represents a garage door. """ # pylint: disable=no-self-use @property @@ -102,6 +101,7 @@ class GarageDoorDevice(Entity): @property def state(self): + """ State of the garage door. """ closed = self.is_closed if closed is None: return STATE_UNKNOWN diff --git a/homeassistant/components/garage_door/demo.py b/homeassistant/components/garage_door/demo.py index 0562383a8bd..678565bbc32 100644 --- a/homeassistant/components/garage_door/demo.py +++ b/homeassistant/components/garage_door/demo.py @@ -1,7 +1,6 @@ """ homeassistant.components.garage_door.demo -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Demo platform that has two fake garage doors. """ from homeassistant.components.garage_door import GarageDoorDevice diff --git a/homeassistant/components/garage_door/wink.py b/homeassistant/components/garage_door/wink.py index 73d6928b9e2..aa714a790ca 100644 --- a/homeassistant/components/garage_door/wink.py +++ b/homeassistant/components/garage_door/wink.py @@ -1,6 +1,6 @@ """ homeassistant.components.garage_door.wink -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Support for Wink garage doors. For more details about this platform, please refer to the documentation at