From 3870d2e0cde60d0fc3d63e6c980f8c20b17eec5a Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 1 Jul 2016 21:39:30 +0200 Subject: [PATCH] Docstring updates (#2404) * Fix docstring * Fix typo * Update docstrings * Update docstrings --- homeassistant/components/binary_sensor/envisalink.py | 2 +- homeassistant/components/envisalink.py | 6 +++--- homeassistant/components/persistent_notification.py | 2 +- homeassistant/components/sensor/envisalink.py | 2 +- homeassistant/util/yaml.py | 12 ++++++------ 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/homeassistant/components/binary_sensor/envisalink.py b/homeassistant/components/binary_sensor/envisalink.py index 144de83aa53..0d82626685a 100644 --- a/homeassistant/components/binary_sensor/envisalink.py +++ b/homeassistant/components/binary_sensor/envisalink.py @@ -33,7 +33,7 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None): class EnvisalinkBinarySensor(EnvisalinkDevice, BinarySensorDevice): - """Representation of an envisalink Binary Sensor.""" + """Representation of an Envisalink binary sensor.""" # pylint: disable=too-many-arguments def __init__(self, zone_number, zone_name, zone_type, info, controller): diff --git a/homeassistant/components/envisalink.py b/homeassistant/components/envisalink.py index 23f9acef12f..ab4312ff20f 100644 --- a/homeassistant/components/envisalink.py +++ b/homeassistant/components/envisalink.py @@ -149,7 +149,7 @@ def setup(hass, base_config): EVL_CONTROLLER.stop() def start_envisalink(event): - """Startup process for the envisalink.""" + """Startup process for the Envisalink.""" EVL_CONTROLLER.start() for _ in range(10): if 'success' in _connect_status: @@ -175,7 +175,7 @@ def setup(hass, base_config): if not _result: return False - # Load sub-components for envisalink + # Load sub-components for Envisalink if _partitions: load_platform(hass, 'alarm_control_panel', 'envisalink', {'partitions': _partitions, @@ -191,7 +191,7 @@ def setup(hass, base_config): class EnvisalinkDevice(Entity): - """Representation of an envisalink devicetity.""" + """Representation of an Envisalink device.""" def __init__(self, name, info, controller): """Initialize the device.""" diff --git a/homeassistant/components/persistent_notification.py b/homeassistant/components/persistent_notification.py index 66a634616fa..6b31da76849 100644 --- a/homeassistant/components/persistent_notification.py +++ b/homeassistant/components/persistent_notification.py @@ -33,7 +33,7 @@ _LOGGER = logging.getLogger(__name__) def create(hass, message, title=None, notification_id=None): - """Turn all or specified light off.""" + """Generate a notification.""" data = { key: value for key, value in [ (ATTR_TITLE, title), diff --git a/homeassistant/components/sensor/envisalink.py b/homeassistant/components/sensor/envisalink.py index cd71673b99f..dcb8cc201d7 100644 --- a/homeassistant/components/sensor/envisalink.py +++ b/homeassistant/components/sensor/envisalink.py @@ -30,7 +30,7 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None): class EnvisalinkSensor(EnvisalinkDevice): - """Representation of an envisalink keypad.""" + """Representation of an Envisalink keypad.""" def __init__(self, partition_name, partition_number, info, controller): """Initialize the sensor.""" diff --git a/homeassistant/util/yaml.py b/homeassistant/util/yaml.py index 0e6ec01f26e..4dc28269bd1 100644 --- a/homeassistant/util/yaml.py +++ b/homeassistant/util/yaml.py @@ -51,7 +51,7 @@ def _include_yaml(loader, node): def _include_dir_named_yaml(loader, node): - """Load multiple files from dir as a dict.""" + """Load multiple files from directory as a dictionary.""" mapping = OrderedDict() files = os.path.join(os.path.dirname(loader.name), node.value, '*.yaml') for fname in glob.glob(files): @@ -61,7 +61,7 @@ def _include_dir_named_yaml(loader, node): def _include_dir_merge_named_yaml(loader, node): - """Load multiple files from dir as a merged dict.""" + """Load multiple files from directory as a merged dictionary.""" mapping = OrderedDict() files = os.path.join(os.path.dirname(loader.name), node.value, '*.yaml') for fname in glob.glob(files): @@ -72,13 +72,13 @@ def _include_dir_merge_named_yaml(loader, node): def _include_dir_list_yaml(loader, node): - """Load multiple files from dir as a list.""" + """Load multiple files from directory as a list.""" files = os.path.join(os.path.dirname(loader.name), node.value, '*.yaml') return [load_yaml(f) for f in glob.glob(files)] def _include_dir_merge_list_yaml(loader, node): - """Load multiple files from dir as a merged list.""" + """Load multiple files from directory as a merged list.""" files = os.path.join(os.path.dirname(loader.name), node.value, '*.yaml') merged_list = [] for fname in glob.glob(files): @@ -89,7 +89,7 @@ def _include_dir_merge_list_yaml(loader, node): def _ordered_dict(loader, node): - """Load YAML mappings into an ordered dict to preserve key order.""" + """Load YAML mappings into an ordered dictionary to preserve key order.""" loader.flatten_mapping(node) nodes = loader.construct_pairs(node) @@ -127,7 +127,7 @@ def _env_var_yaml(loader, node): # pylint: disable=protected-access def _secret_yaml(loader, node): """Load secrets and embed it into the configuration YAML.""" - # Create secret cache on loader and load secret.yaml + # Create secret cache on loader and load secrets.yaml if not hasattr(loader, '_SECRET_CACHE'): loader._SECRET_CACHE = {}