From 847e92f57a6cdaf0d8196987e76ec728e8d24c48 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 3 Feb 2016 00:01:26 +0100 Subject: [PATCH] Update docstrings --- homeassistant/components/alarm_control_panel/alarmdotcom.py | 2 ++ homeassistant/components/sensor/systemmonitor.py | 4 ++++ homeassistant/components/sensor/twitch.py | 1 + homeassistant/components/weblink.py | 2 -- 4 files changed, 7 insertions(+), 2 deletions(-) diff --git a/homeassistant/components/alarm_control_panel/alarmdotcom.py b/homeassistant/components/alarm_control_panel/alarmdotcom.py index 7f76680feb7..f1b2fe76238 100644 --- a/homeassistant/components/alarm_control_panel/alarmdotcom.py +++ b/homeassistant/components/alarm_control_panel/alarmdotcom.py @@ -57,10 +57,12 @@ class AlarmDotCom(alarm.AlarmControlPanel): @property def should_poll(self): + """ No polling needed. """ return True @property def name(self): + """ Returns the name of the device. """ return self._name @property diff --git a/homeassistant/components/sensor/systemmonitor.py b/homeassistant/components/sensor/systemmonitor.py index 3e9169d8635..63052e71b93 100644 --- a/homeassistant/components/sensor/systemmonitor.py +++ b/homeassistant/components/sensor/systemmonitor.py @@ -67,10 +67,12 @@ class SystemMonitorSensor(Entity): @property def name(self): + """ Returns the name of the sensor. """ return self._name.rstrip() @property def icon(self): + """ Icon to use in the frontend, if any. """ return SENSOR_TYPES[self.type][2] @property @@ -80,10 +82,12 @@ class SystemMonitorSensor(Entity): @property def unit_of_measurement(self): + """ Unit of measurement of this entity, if any. """ return self._unit_of_measurement # pylint: disable=too-many-branches def update(self): + """ Get the latest system informations. """ import psutil if self.type == 'disk_use_percent': self._state = psutil.disk_usage(self.argument).percent diff --git a/homeassistant/components/sensor/twitch.py b/homeassistant/components/sensor/twitch.py index 43077701f86..b2de3f71fa1 100644 --- a/homeassistant/components/sensor/twitch.py +++ b/homeassistant/components/sensor/twitch.py @@ -78,4 +78,5 @@ class TwitchSensor(Entity): @property def icon(self): + """ Icon to use in the frontend, if any. """ return ICON diff --git a/homeassistant/components/weblink.py b/homeassistant/components/weblink.py index 96c4f0f4dd1..3328e67b53b 100644 --- a/homeassistant/components/weblink.py +++ b/homeassistant/components/weblink.py @@ -25,8 +25,6 @@ _LOGGER = logging.getLogger(__name__) def setup(hass, config): """ Setup weblink component. """ - # States are in the format DOMAIN.OBJECT_ID - links = config.get(DOMAIN) for link in links.get('entities'):