[doc] Add description, usage and notes to all modules

This commit is contained in:
Tobias Witek 2016-10-31 16:08:03 +01:00
parent 598f3e70e9
commit c0421163d4
10 changed files with 92 additions and 3 deletions

View file

@ -2,13 +2,13 @@ import datetime
import bumblebee.module
def usage():
return "battery::<battery ID, defaults to BAT0>"
return "battery or battery::<battery ID, defaults to BAT0>"
def notes():
return "Reads /sys/class/power_supply/<ID>/[capacity|status]"
return "Reads /sys/class/power_supply/<ID>/[capacity|status]. Warning is at 20% remaining charge, Critical at 10%."
def description():
return "Displays battery status, percentage and whether it's charging or discharging"
return "Displays battery status, percentage and whether it's charging or discharging."
class Module(bumblebee.module.Module):
def __init__(self, args):