summaryrefslogtreecommitdiffstats
path: root/py3status/modules/pomodoro.py
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
committerUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
commitada99c0af5665828abc725923bf2f104c577c852 (patch)
treea4e58a0d9a5bec4612efe98bf068730a45c32ef7 /py3status/modules/pomodoro.py
parentcdfec19502d0415f92d85ffa48e6bec495ccb644 (diff)
move config parameters on every module docstring, overall QA
Diffstat (limited to 'py3status/modules/pomodoro.py')
-rw-r--r--py3status/modules/pomodoro.py22
1 files changed, 11 insertions, 11 deletions
diff --git a/py3status/modules/pomodoro.py b/py3status/modules/pomodoro.py
index 38f8020..25149a7 100644
--- a/py3status/modules/pomodoro.py
+++ b/py3status/modules/pomodoro.py
@@ -2,6 +2,17 @@
"""
Display and control a Pomodoro countdown.
+Configuration parameters:
+ - display_bar: display time in bars when True, otherwise in seconds
+ - max_breaks: maximum number of breaks
+ - num_progress_bars: number of progress bars
+ - sound_break_end: break end sound (file path)
+ - sound_pomodoro_end: pomodoro end sound (file path)
+ - sound_pomodoro_start: pomodoro start sound (file path)
+ - timer_break: normal break time (seconds) (requires pygame)
+ - timer_long_break: long break time (seconds) (requires pygame)
+ - timer_pomodoro: pomodoro time (seconds) (requires pygame)
+
@author Fandekasp (Adrien Lemaire), rixx, FedericoCeratto
"""
@@ -21,18 +32,7 @@ PROGRESS_BAR_ITEMS = u"▏▎▍▌▋▊▉"
class Py3status:
"""
- Configuration parameters:
- - display_bar: display time in bars when True, otherwise in seconds
- - max_breaks: maximum number of breaks
- - num_progress_bars: number of progress bars
- - sound_break_end: break end sound (file path)
- - sound_pomodoro_end: pomodoro end sound (file path)
- - sound_pomodoro_start: pomodoro start sound (file path)
- - timer_break: normal break time (seconds) (requires pygame)
- - timer_long_break: long break time (seconds) (requires pygame)
- - timer_pomodoro: pomodoro time (seconds) (requires pygame)
"""
-
# available configuration parameters
display_bar = False
max_breaks = 4