[PATCH] Re: org-agenda-clock-report-header

[Ihor Radchenko]

Colin Baxter <m43cap@yandex.com> writes:

> Could more information perhaps be added to the doc string of
> "org-agenda-clock-report-header"? And an example would be very
> useful. As it stands at present, I haven't a clue as to what the
> variable does and why it might be useful.

It's literally a string inserted right before the table. There is
nothing much to show there. See
https://orgmode.org/list/CAJAdVc06_tj58Je=tn42JqfUtkjamQBQdcvobQXeegARS_M0hQ@mail.gmail.com

Is version in the attached patch more clear?

Best,
Ihor

>From 9b5f5844aedfab9f36ba89ed8beca36651370c0a Mon Sep 17 00:00:00 2001
Message-Id: 
<9b5f5844aedfab9f36ba89ed8beca36651370c0a.1652099870.git.yantar92@gmail.com>
From: Ihor Radchenko <yantar92@gmail.com>
Date: Mon, 9 May 2022 20:34:38 +0800
Subject: [PATCH] org-agenda-clock-report-header: Update docstring

See 87o808j6si.fsf@yandex.com">https://orgmode.org/list/87o808j6si.fsf@yandex.com
---
 lisp/org-agenda.el | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 0479a0e1f..9d38b889d 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -1221,11 +1221,11 @@ (defcustom org-agenda-timegrid-use-ampm nil
   :type 'boolean)
 
 (defcustom org-agenda-clock-report-header nil
-  "Header for org agenda clock report mode"
+  "Header inserted before the table in Org agenda clock report mode."
   :group 'org-agenda
   :type '(choice
-    (string :tag "Header")
-    (const :tag "No header" nil))
+          (string :tag "Header")
+          (const :tag "No header" nil))
   :safe #'stringp
   :package-version '(Org . "9.6"))
 
-- 
2.35.1