Re: Bug: Docstrings of =org-agenda-todo-ignore-with-date= and =org-agenda-todo-ignore-timestamp= unclear [9.2 (release_9.2-215-g5b39d8 @ /home/mbork/others-works/emacs/org-mode/lisp/)]

[Marcin Borkowski <mbork@mbork.pl>]

[-- Attachment #1: Type: text/plain, Size: 1234 bytes --]


On 2019-06-23, at 13:23, Marcin Borkowski <mbork@mbork.pl> wrote:

> On 2019-06-19, at 21:19, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
>
>> Hello,
>>
>> Marcin Borkowski <mbork@mbork.pl> writes:
>>
>>> The docstrings of =org-agenda-todo-ignore-with-date= and
>>> =org-agenda-todo-ignore-timestamp= do not really tell what these
>>> settings are doing.  They should (imho) emphasize that the former just
>>> omits from the global todo list all entries with at least one active
>>> timestamp (in the hedaline or the body), and the latter checks the first
>>> active timestamp which is not SCHEDULED or DEADLINE and compares it to
>>> today's date.
>>>
>>> It could also be mentioned in the manual.
>>>
>>> I have GNU papers for Emacs signed.  If this is enough, I'd be happy to
>>> submit a patch.  If so, what would be better: to patch only the
>>> docstrings or the docstrings and the manual.
>>
>> I would say the latter. Thank you.
>
> I only patched the doctsrings for now.  If this is fine, I'll do
> a similar thing in the manual.

I attach two more patches: one for the manual and one for the (apparent)
bug in `org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item`.

WDYT?

-- 
Marcin Borkowski
http://mbork.pl

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0002-Explain-the-org-agenda-todo-ignore-.-variables-in-th.patch --]
[-- Type: text/x-patch; size=1.41KiB, Size: 1448 bytes --]

From 89e1254d04802b13f4bd8c753287bce4eb1ae044 Mon Sep 17 00:00:00 2001
From: Marcin Borkowski <mbork@mbork.pl>
Date: Mon, 24 Jun 2019 21:05:32 +0200
Subject: [PATCH] Explain the `org-agenda-todo-ignore-...` variables in the
 manual

---
 doc/org-manual.org | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 440888b4e..573c59b99 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -8545,11 +8545,13 @@ it more compact:
   #+vindex: org-agenda-todo-ignore-with-date
   Some people view a TODO item that has been /scheduled/ for execution
   or have a /deadline/ (see [[*Timestamps]]) as no longer /open/.
-  Configure the variables ~org-agenda-todo-ignore-scheduled~,
-  ~org-agenda-todo-ignore-deadlines~,
-  ~org-agenda-todo-ignore-timestamp~ and/or
-  ~org-agenda-todo-ignore-with-date~ to exclude such items from the
-  global TODO list.
+  Configure the variables ~org-agenda-todo-ignore-scheduled~ to
+  exclude some or all scheduled items from the global TODO list,
+  ~org-agenda-todo-ignore-deadlines~ to exclude some or all items with
+  a deadline set, ~org-agenda-todo-ignore-timestamp~ to exclude some
+  or all items with an active timestamp other than a DEADLINE or
+  a SCHEDULED timestamp and/or ~org-agenda-todo-ignore-with-date~ to
+  exclude items with at least one active timestamp.
 
 -
   #+vindex: org-agenda-todo-list-sublevels
-- 
2.22.0


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0003-Fix-a-bug-when-org-agenda-todo-ignore-deadlines-is-s.patch --]
[-- Type: text/x-patch; size=914B, Size: 914 bytes --]

From 0bf1e6e6b25847ce4bee74487782b82c822138a3 Mon Sep 17 00:00:00 2001
From: Marcin Borkowski <mbork@mbork.pl>
Date: Mon, 24 Jun 2019 21:05:56 +0200
Subject: [PATCH] Fix a bug when `org-agenda-todo-ignore-deadlines` is set to t

---
 lisp/org-agenda.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index daf51601d..673c3c311 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -5444,7 +5444,7 @@ This function is invoked if `org-agenda-todo-ignore-deadlines',
 	  (and org-agenda-todo-ignore-deadlines
 	       (re-search-forward org-deadline-time-regexp end t)
 	       (cond
-		((memq org-agenda-todo-ignore-deadlines '(t all)) t)
+		((eq org-agenda-todo-ignore-deadlines 'all) t)
 		((eq org-agenda-todo-ignore-deadlines 'far)
 		 (not (org-deadline-close-p (match-string 1))))
 		((eq org-agenda-todo-ignore-deadlines 'future)
-- 
2.22.0