Update docstrings and link to docs
parent
314185ffb8
commit
4ea6def1bd
|
@ -1,10 +1,10 @@
|
||||||
"""
|
"""
|
||||||
homeassistant.components.sensor.updater
|
homeassistant.components.updater
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Sensor that checks for available updates.
|
Component that checks for available updates.
|
||||||
|
|
||||||
For more details about this platform, please refer to the documentation at
|
For more details about this platform, please refer to the documentation at
|
||||||
at https://home-assistant.io/components/sensor.updater/
|
at https://home-assistant.io/components/updater/
|
||||||
"""
|
"""
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
|
@ -22,10 +22,10 @@ ENTITY_ID = 'updater.updater'
|
||||||
|
|
||||||
|
|
||||||
def setup(hass, config):
|
def setup(hass, config):
|
||||||
''' setup the updater component '''
|
""" Setup the updater component. """
|
||||||
|
|
||||||
def check_newest_version(_=None):
|
def check_newest_version(_=None):
|
||||||
''' check if a new version is available and report if one is '''
|
""" Check if a new version is available and report if one is. """
|
||||||
newest = get_newest_version()
|
newest = get_newest_version()
|
||||||
|
|
||||||
if newest != CURRENT_VERSION and newest is not None:
|
if newest != CURRENT_VERSION and newest is not None:
|
||||||
|
@ -41,7 +41,7 @@ def setup(hass, config):
|
||||||
|
|
||||||
|
|
||||||
def get_newest_version():
|
def get_newest_version():
|
||||||
''' Get the newest HA version form PyPI '''
|
""" Get the newest Home Assistant version from PyPI. """
|
||||||
try:
|
try:
|
||||||
req = requests.get(PYPI_URL)
|
req = requests.get(PYPI_URL)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue