From f9cecdee288e61dd53938fa74d3c28c026a49c89 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 7 Sep 2015 18:26:20 +0200 Subject: [PATCH] Update docstring (config file) and attempt to honor PEP0257 --- homeassistant/components/notify/file.py | 3 +-- homeassistant/components/notify/instapush.py | 6 ++---- homeassistant/components/notify/nma.py | 6 ++---- homeassistant/components/notify/pushbullet.py | 5 ++--- homeassistant/components/notify/pushover.py | 10 ++++------ homeassistant/components/notify/slack.py | 2 +- homeassistant/components/notify/smtp.py | 5 ++--- homeassistant/components/notify/syslog.py | 3 +-- homeassistant/components/notify/xmpp.py | 2 +- 9 files changed, 16 insertions(+), 26 deletions(-) diff --git a/homeassistant/components/notify/file.py b/homeassistant/components/notify/file.py index 186bc53ca98..9c0beca14ac 100644 --- a/homeassistant/components/notify/file.py +++ b/homeassistant/components/notify/file.py @@ -1,13 +1,12 @@ """ homeassistant.components.notify.file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - File notification service. Configuration: To use the File notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: file diff --git a/homeassistant/components/notify/instapush.py b/homeassistant/components/notify/instapush.py index 531ef758e05..95ff0d41435 100644 --- a/homeassistant/components/notify/instapush.py +++ b/homeassistant/components/notify/instapush.py @@ -1,13 +1,12 @@ """ homeassistant.components.notify.instapush ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Instapush notification service. Configuration: To use the Instapush notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: instapush @@ -16,7 +15,7 @@ notify: event: YOUR_EVENT tracker: YOUR_TRACKER -VARIABLES: +Variables: api_key *Required @@ -50,7 +49,6 @@ curl -X POST \ https://api.instapush.im/v1/post Details for the API : https://instapush.im/developer/rest - """ import logging import json diff --git a/homeassistant/components/notify/nma.py b/homeassistant/components/notify/nma.py index db6c91d8fed..bf8fb2162a8 100644 --- a/homeassistant/components/notify/nma.py +++ b/homeassistant/components/notify/nma.py @@ -1,19 +1,18 @@ """ homeassistant.components.notify.nma ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - NMA (Notify My Android) notification service. Configuration: To use the NMA notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: nma api_key: YOUR_API_KEY -VARIABLES: +Variables: api_key *Required @@ -21,7 +20,6 @@ Enter the API key for NMA. Go to https://www.notifymyandroid.com and create a new API key to use with Home Assistant. Details for the API : https://www.notifymyandroid.com/api.jsp - """ import logging import xml.etree.ElementTree as ET diff --git a/homeassistant/components/notify/pushbullet.py b/homeassistant/components/notify/pushbullet.py index 58462954d2e..76eaf5c0c37 100644 --- a/homeassistant/components/notify/pushbullet.py +++ b/homeassistant/components/notify/pushbullet.py @@ -1,13 +1,12 @@ """ homeassistant.components.notify.pushbullet ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - PushBullet platform for notify component. Configuration: To use the PushBullet notifier you will need to add something like the -following to your config/configuration.yaml +following to your configuration.yaml file. notify: platform: pushbullet @@ -32,7 +31,7 @@ REQUIREMENTS = ['pushbullet.py==0.7.1'] def get_service(hass, config): - """ Get the pushbullet notification service. """ + """ Get the PushBullet notification service. """ if not validate_config(config, {DOMAIN: [CONF_API_KEY]}, diff --git a/homeassistant/components/notify/pushover.py b/homeassistant/components/notify/pushover.py index 0df035a4a6e..c52e430ac9f 100644 --- a/homeassistant/components/notify/pushover.py +++ b/homeassistant/components/notify/pushover.py @@ -1,18 +1,17 @@ """ homeassistant.components.notify.pushover ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Pushover platform for notify component. Configuration: To use the Pushover notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: - platform: pushover - api_key: ABCDEFGHJKLMNOPQRSTUVXYZ - user_key: ABCDEFGHJKLMNOPQRSTUVXYZ + platform: pushover + api_key: ABCDEFGHJKLMNOPQRSTUVXYZ + user_key: ABCDEFGHJKLMNOPQRSTUVXYZ Variables: @@ -33,7 +32,6 @@ https://home-assistant.io/images/favicon-192x192.png user_key *Required To retrieve this value log into your account at https://pushover.net - """ import logging diff --git a/homeassistant/components/notify/slack.py b/homeassistant/components/notify/slack.py index d604cffb754..bd3a2b71c0c 100644 --- a/homeassistant/components/notify/slack.py +++ b/homeassistant/components/notify/slack.py @@ -6,7 +6,7 @@ Slack platform for notify component. Configuration: To use the Slack notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: slack diff --git a/homeassistant/components/notify/smtp.py b/homeassistant/components/notify/smtp.py index 998391c81b4..0530ac4072d 100644 --- a/homeassistant/components/notify/smtp.py +++ b/homeassistant/components/notify/smtp.py @@ -1,13 +1,12 @@ """ homeassistant.components.notify.mail ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Mail notification service. +Mail (SMTP) notification service. Configuration: To use the Mail notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: mail diff --git a/homeassistant/components/notify/syslog.py b/homeassistant/components/notify/syslog.py index 6673ba23a08..5d246f2fd0d 100644 --- a/homeassistant/components/notify/syslog.py +++ b/homeassistant/components/notify/syslog.py @@ -1,13 +1,12 @@ """ homeassistant.components.notify.syslog ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Syslog notification service. Configuration: To use the Syslog notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: syslog diff --git a/homeassistant/components/notify/xmpp.py b/homeassistant/components/notify/xmpp.py index 81268c734b7..1d72f6a262b 100644 --- a/homeassistant/components/notify/xmpp.py +++ b/homeassistant/components/notify/xmpp.py @@ -6,7 +6,7 @@ Jabber (XMPP) notification service. Configuration: To use the Jabber notifier you will need to add something like the following -to your config/configuration.yaml +to your configuration.yaml file. notify: platform: xmpp