QA on all modules docstrings for a clean CLI parsing

24 files changed, 51 insertions, 51 deletions

diff --git a/py3status/modules/battery_level.py b/py3status/modules/battery_level.py
index f3cbb37..8b6568c 100644
--- a/py3status/modules/battery_level.py
+++ b/py3status/modules/battery_level.py
@@ -1,11 +1,11 @@
 # -*- coding: utf8 -*-
 """
-Module for displaying information about battery.
+Display the battery level.
 
 Requires:
     - the 'acpi' command line
 
-@author shadowprince and AdamBSteele
+@author shadowprince, AdamBSteele
 @license Eclipse Public License
 """
 
diff --git a/py3status/modules/bitcoin_price.py b/py3status/modules/bitcoin_price.py
index 656797c..477394f 100644
--- a/py3status/modules/bitcoin_price.py
+++ b/py3status/modules/bitcoin_price.py
@@ -1,10 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-Module for displaying bitcoin prices using
-the API by www.bitcoincharts.com.
+Display bitcoin prices using bitcoincharts.com.
 
-Written and contributed by @tasse:
-    Andre Doser <doser.andre AT gmail.com>
+@author Andre Doser <doser.andre AT gmail.com>
 """
 import json
 
diff --git a/py3status/modules/bluetooth.py b/py3status/modules/bluetooth.py
index cd09945..7c5f3ad 100644
--- a/py3status/modules/bluetooth.py
+++ b/py3status/modules/bluetooth.py
@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-This module displays bluetooth status.
+Display bluetooth status.
 
 Requires:
     - hcitool
diff --git a/py3status/modules/clementine.py b/py3status/modules/clementine.py
index faadf1e..2c5c66f 100644
--- a/py3status/modules/clementine.py
+++ b/py3status/modules/clementine.py
@@ -1,10 +1,9 @@
 # -*- coding: utf-8 -*-
 """
-This module displays the current "artist - title" playing in Clementine.
+Display the current "artist - title" playing in Clementine.
 
-Last modified: 2014-03-23
-Author: Francois LASSERRE <choiz@me.com>
-License: GNU GPL http://www.gnu.org/licenses/gpl.html
+@author Francois LASSERRE <choiz@me.com>
+@license GNU GPL http://www.gnu.org/licenses/gpl.html
 """
 
 from time import time
diff --git a/py3status/modules/dpms.py b/py3status/modules/dpms.py
index bcef53c..0753df4 100644
--- a/py3status/modules/dpms.py
+++ b/py3status/modules/dpms.py
@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
 """
+Activate or deactivate DPMS and screen blanking.
+
 This module allows activation and deactivation
 of DPMS (Display Power Management Signaling)
 by clicking on 'DPMS' in the status bar.
 
-Written and contributed by @tasse:
-    Andre Doser <dosera AT tf.uni-freiburg.de>
+@author Andre Doser <dosera AT tf.uni-freiburg.de>
 """
 
 from os import system
diff --git a/py3status/modules/glpi.py b/py3status/modules/glpi.py
index db648e0..708ed4f 100644
--- a/py3status/modules/glpi.py
+++ b/py3status/modules/glpi.py
@@ -1,13 +1,9 @@
 # -*- coding: utf-8 -*-
 """
-This example class demonstrates how to display the current total number of
-open tickets from GLPI in your i3bar.
+Display the total number of open tickets from GLPI.
 
 It features thresholds to colorize the output and forces a low timeout to
 limit the impact of a server connectivity problem on your i3bar freshness.
-
-Note that we don't have to implement a cache layer as it is handled by
-py3status automagically.
 """
 
 # You need MySQL-python from http://pypi.python.org/pypi/MySQL-python
diff --git a/py3status/modules/imap.py b/py3status/modules/imap.py
index ff53f02..a30680a 100644
--- a/py3status/modules/imap.py
+++ b/py3status/modules/imap.py
@@ -1,8 +1,6 @@
 # -*- coding: utf8 -*-
 """
-Module displaying the number of unread messages
-on an IMAP inbox (configurable, may also be a
-comma-separated list of IMAP folders).
+Display the unread messages count from your IMAP account.
 
 @author obb
 """
diff --git a/py3status/modules/keyboard_layout.py b/py3status/modules/keyboard_layout.py
index f7a570c..d8eb7cc 100644
--- a/py3status/modules/keyboard_layout.py
+++ b/py3status/modules/keyboard_layout.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Module for showing current keyboard layout.
+Display the current keyboard layout.
 
 Requires:
     - xkblayout-state
diff --git a/py3status/modules/mpd_status.py b/py3status/modules/mpd_status.py
index 10f3c99..a30830e 100644
--- a/py3status/modules/mpd_status.py
+++ b/py3status/modules/mpd_status.py
@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-Mpd - module to show information from mpd in your i3bar.
-Reequires
+Display information from mpd.
+
+Requires:
     - python-mpd2 (NOT python2-mpd2)
     # pip install python-mpd2
 
diff --git a/py3status/modules/net_rate.py b/py3status/modules/net_rate.py
index 876f6cb..0212768 100644
--- a/py3status/modules/net_rate.py
+++ b/py3status/modules/net_rate.py
@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 """
-Module for displaying current network transfer rate.
+Display the current network transfer rate.
 
 @author shadowprince
 @license Eclipse Public License
diff --git a/py3status/modules/netdata.py b/py3status/modules/netdata.py
index fe9406f..c43ad06 100644
--- a/py3status/modules/netdata.py
+++ b/py3status/modules/netdata.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-Display network information (Linux systems) in i3bar.
+Display network speed and bandwidth usage.
 
-Copyright (C) <2013> <Shahin Azad [ishahinism at Gmail]>
+@author Shahin Azad <ishahinism at Gmail>
 """
 
 import subprocess
diff --git a/py3status/modules/ns_checker.py b/py3status/modules/ns_checker.py
index 5fa6384..d21bbb0 100644
--- a/py3status/modules/ns_checker.py
+++ b/py3status/modules/ns_checker.py
@@ -1,12 +1,14 @@
 # -*- coding: utf-8 -*-
 """
+Display DNS resolution success on a configured domain.
+
 This module launch a simple query on each nameservers for the specified domain.
 Nameservers are dynamically retrieved. The FQDN is the only one mandatory parameter.
 It's also possible to add additional nameservers by appending them in nameservers list.
 
 The default resolver can be overwritten with my_resolver.nameservers parameter.
 
-Written and contributed by @nawadanp
+@author nawadanp
 """
 
 import dns.resolver
diff --git a/py3status/modules/online_status.py b/py3status/modules/online_status.py
index 8cc6eeb..8176d21 100644
--- a/py3status/modules/online_status.py
+++ b/py3status/modules/online_status.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Module displaying if a connection to the internet is established.
+Display if a connection to the internet is established.
 
 @author obb
 """
diff --git a/py3status/modules/pingdom.py b/py3status/modules/pingdom.py
index c4ec473..f47da68 100644
--- a/py3status/modules/pingdom.py
+++ b/py3status/modules/pingdom.py
@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 """
-Dynamically display the latest response time of the configured checks using
-the Pingdom API.
+Display the latest response time of the configured Pingdom checks.
+
 We also verify the status of the checks and colorize if needed.
 Pingdom API doc : https://www.pingdom.com/services/api-documentation-rest/
 
-#NOTE: This module needs the 'requests' python module from pypi
-    https://pypi.python.org/pypi/requests
+Requires:
+    - requests python module from pypi
+      https://pypi.python.org/pypi/requests
 """
 
 import requests
diff --git a/py3status/modules/player_control.py b/py3status/modules/player_control.py
index 4f00602..ba8f37d 100644
--- a/py3status/modules/player_control.py
+++ b/py3status/modules/player_control.py
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
-
 """
-Control music/video players
+Control music/video players.
 
 Provides an icon to control simple functions of audio/video players:
  - start (left click)
@@ -54,7 +53,7 @@ class Py3status:
             if self.volume_tick is None:
                 return
 
-            self._change_volume(button=='up')
+            self._change_volume(button == 'up')
             return
 
         if self.status == 'play':
diff --git a/py3status/modules/pomodoro.py b/py3status/modules/pomodoro.py
index ecb3f57..94b8ef6 100644
--- a/py3status/modules/pomodoro.py
+++ b/py3status/modules/pomodoro.py
@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-Pomodoro countdown on i3bar originally written by @Fandekasp (Adrien Lemaire)
+Display and control a Pomodoro countdown.
+
+@author Fandekasp (Adrien Lemaire), rixx, FedericoCeratto
 """
 
 from subprocess import call
@@ -212,7 +214,7 @@ class Py3status:
 
         try:
             mixer.music.load(sound_fname)
-        except Exception as e:
+        except Exception:
             return
 
         mixer.music.play()
diff --git a/py3status/modules/scratchpad_counter.py b/py3status/modules/scratchpad_counter.py
index 4bfad23..3619cda 100644
--- a/py3status/modules/scratchpad_counter.py
+++ b/py3status/modules/scratchpad_counter.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Module showing amount of windows at the scratchpad.
+Display the amount of windows in your i3 scratchpad.
 
 @author shadowprince
 @license Eclipse Public License
diff --git a/py3status/modules/spaceapi.py b/py3status/modules/spaceapi.py
index 719ee3e..c4eac58 100644
--- a/py3status/modules/spaceapi.py
+++ b/py3status/modules/spaceapi.py
@@ -1,10 +1,9 @@
 # -*- coding: utf-8 -*-
 """
-This module shows if your favorite hackerspace is open or not
+Display if your favorite hackerspace is open or not.
 
-Last modified: 2015-02-01
-Author: @timmszigat
-License: WTFPL http://www.wtfpl.net/txt/copying/
+@author timmszigat
+@license WTFPL <http://www.wtfpl.net/txt/copying/>
 """
 
 import codecs
diff --git a/py3status/modules/sysdata.py b/py3status/modules/sysdata.py
index 0badbe0..34bf97a 100644
--- a/py3status/modules/sysdata.py
+++ b/py3status/modules/sysdata.py
@@ -1,13 +1,12 @@
 # -*- coding: utf-8 -*-
 """
-Sysdata is a module used to display system information (RAM usage)
-in i3bar (Linux systems).
+Display system RAM and CPU utilization.
 
 NOTE: If you want py3status to show you your CPU temperature,
 change value of CPUTEMP into True in Py3status class - CPUInfo function
 and REMEMBER that you must install lm_sensors if you want CPU temp!
 
-Copyright (C) <2013> <Shahin Azad [ishahinism at Gmail]>
+@author Shahin Azad <ishahinism at Gmail>
 """
 
 import subprocess
diff --git a/py3status/modules/vnstat.py b/py3status/modules/vnstat.py
index ad33b71..b506180 100644
--- a/py3status/modules/vnstat.py
+++ b/py3status/modules/vnstat.py
@@ -1,7 +1,9 @@
 # -*- coding: utf8 -*-
 """
-Module for displaying vnstat's statistics.
-REQUIRE external program called "vnstat" installed and configured to work.
+Display vnstat statistics.
+
+Requires:
+    - external program called "vnstat" installed and configured to work.
 
 @author shadowprince
 @license Eclipse Public License
diff --git a/py3status/modules/weather_yahoo.py b/py3status/modules/weather_yahoo.py
index df202d0..0e5d880 100644
--- a/py3status/modules/weather_yahoo.py
+++ b/py3status/modules/weather_yahoo.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-Display current day + 3 days weather forecast as icons on your i3bar
+Display Yahoo! Weather forecast as icons.
+
 Based on Yahoo! Weather. forecast, thanks guys !
     http://developer.yahoo.com/weather/
 
diff --git a/py3status/modules/whoami.py b/py3status/modules/whoami.py
index 884cbf5..aea11fb 100644
--- a/py3status/modules/whoami.py
+++ b/py3status/modules/whoami.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Simply output the currently logged in user in i3bar.
+Display the currently logged in user.
 
 Inspired by i3 FAQ:
     https://faq.i3wm.org/question/1618/add-user-name-to-status-bar/
diff --git a/py3status/modules/window_title.py b/py3status/modules/window_title.py
index 3972ff6..a24f61c 100644
--- a/py3status/modules/window_title.py
+++ b/py3status/modules/window_title.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Py3status plugin - shows current window title.
+Display the current window title.
 
 Requires:
     - i3-py (https://github.com/ziberna/i3-py)
diff --git a/py3status/modules/xrandr.py b/py3status/modules/xrandr.py
index 4ddd856..ef88925 100644
--- a/py3status/modules/xrandr.py
+++ b/py3status/modules/xrandr.py
@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 """
+Control your screen(s) layout easily.
+
 This modules allows you to handle your screens outputs directly from your bar!
     - Detect and propose every possible screen combinations
     - Switch between combinations using click events and mouse scroll