From 54d5e83909454972e63a4fedbec85d3d071fec45 Mon Sep 17 00:00:00 2001 From: Alex Kelly Date: Mon, 12 Sep 2022 13:43:10 -0400 Subject: [PATCH] [modules/taskwarrior] Update docstring with show.active stuff --- bumblebee_status/modules/contrib/taskwarrior.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/bumblebee_status/modules/contrib/taskwarrior.py b/bumblebee_status/modules/contrib/taskwarrior.py index 7bc4c39..9aa6157 100644 --- a/bumblebee_status/modules/contrib/taskwarrior.py +++ b/bumblebee_status/modules/contrib/taskwarrior.py @@ -24,7 +24,12 @@ class Module(core.module.Module): self.__pending_tasks = "0" def update(self): - """Return a string with the number of pending tasks from TaskWarrior.""" + """Return a string with the number of pending tasks from TaskWarrior + or the descripton of an active task. + + if show.active is set in the config, show the description of the + current active task, otherwise the number of pending tasks will be displayed. + """ try: taskrc = self.parameter("taskrc", "~/.taskrc") show_active = self.parameter("show_active", False) @@ -33,6 +38,8 @@ class Module(core.module.Module): w.filter_tasks({"start.any": "", "status": "pending"}) or None ) if show_active and active_tasks: + # this is using the first element of the list, if there happen + # to be other active tasks, they won't be displayed. reporting_tasks = ( f"{active_tasks[0]['id']} - {active_tasks[0]['description']}" )