Fix the docstring of get-clocked-task-json

This commit is contained in:
Gergely Polonkai 2021-03-11 06:08:03 +01:00
parent 4c0b28032e
commit d3d80e6e38
No known key found for this signature in database
GPG Key ID: 2D2885533B869ED4
1 changed files with 4 additions and 3 deletions

View File

@ -59,10 +59,11 @@
"Coding system of the file `org-clock-waybar-filename'.")
(defun org-clock-waybar--get-clocked-task-json (buffer)
"Save the current clocked-in tasks title and category to BUFFER.
"Save the currently clocked-in tasks data to BUFFER.
The output is in JSON format. If there is no clocked in task, both title and
category will be a JSON null value."
The output is in JSON format constructed in a way so Waybar can process it.
If there is no clocked in task, alt becomes empty and text will be set to
'Not clocked in'."
(let ((category (when org-clock-current-task
(get-text-property 0 'org-category org-clock-current-task)))
(title (when org-clock-current-task