[modules] Add help texts

see #23
This commit is contained in:
Tobi-wan Kenobi 2016-12-10 12:03:58 +01:00
parent 4d4a7bf29d
commit 7ea8c5320d
3 changed files with 19 additions and 3 deletions

View file

@ -1,5 +1,13 @@
# pylint: disable=C0111,R0903 # pylint: disable=C0111,R0903
"""Displays battery status, remaining percentage and charging information.
Parameters:
* battery.device : The device to read information from (defaults to BAT0)
* battery.warning : Warning threshold in % of remaining charge (defaults to 20)
* battery.critical: Critical threshold in % of remaining charge (defaults to 10)
"""
import os import os
import bumblebee.input import bumblebee.input

View file

@ -1,6 +1,10 @@
# pylint: disable=C0111,R0903 # pylint: disable=C0111,R0903
"""Displays information about the current song in cmus.""" """Displays information about the current song in cmus.
Parameters:
* cmus.format: Format string for the song information. Tag values can be put in curly brackets (i.e. {artist})
"""
from collections import defaultdict from collections import defaultdict

View file

@ -1,5 +1,11 @@
#pylint: disable=C0111,R0903 #pylint: disable=C0111,R0903
"""Displays the name, IP address(es) and status of each available network interface.
Parameters:
* nic.exclude: Comma-separated list of interface prefixes to exclude (defaults to "lo,virbr,docker,vboxnet,veth")
"""
import netifaces import netifaces
import bumblebee.util import bumblebee.util
@ -7,8 +13,6 @@ import bumblebee.input
import bumblebee.output import bumblebee.output
import bumblebee.engine import bumblebee.engine
"""Displays the name, IP address(es) and status of each available network interface."""
class Module(bumblebee.engine.Module): class Module(bumblebee.engine.Module):
def __init__(self, engine, config): def __init__(self, engine, config):
widgets = [] widgets = []