From mboxrd@z Thu Jan 1 00:00:00 1970 From: Marcin Borkowski Subject: 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/)] Date: Mon, 24 Jun 2019 21:09:40 +0200 Message-ID: <87blymyf4b.fsf@mbork.pl> References: <87k1dj2xiq.fsf@mbork.pl> <87d0j9pelr.fsf@nicolasgoaziou.fr> <87wohck0jf.fsf@mbork.pl> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:470:142:3::10]:43849) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hfUNM-0008Da-Gx for emacs-orgmode@gnu.org; Mon, 24 Jun 2019 15:11:37 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hfUNL-0007NU-3F for emacs-orgmode@gnu.org; Mon, 24 Jun 2019 15:11:36 -0400 Received: from mail.mojserwer.eu ([195.110.48.8]:53498) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hfUNK-0007MU-Jt for emacs-orgmode@gnu.org; Mon, 24 Jun 2019 15:11:35 -0400 In-reply-to: <87wohck0jf.fsf@mbork.pl> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Nicolas Goaziou Cc: emacs-orgmode@gnu.org --=-=-= Content-Type: text/plain On 2019-06-23, at 13:23, Marcin Borkowski wrote: > On 2019-06-19, at 21:19, Nicolas Goaziou wrote: > >> Hello, >> >> Marcin Borkowski 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 --=-=-= Content-Type: text/x-patch; size=1.41KiB Content-Disposition: attachment; filename=0002-Explain-the-org-agenda-todo-ignore-.-variables-in-th.patch >From 89e1254d04802b13f4bd8c753287bce4eb1ae044 Mon Sep 17 00:00:00 2001 From: Marcin Borkowski 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 --=-=-= Content-Type: text/x-patch; size=914B Content-Disposition: attachment; filename=0003-Fix-a-bug-when-org-agenda-todo-ignore-deadlines-is-s.patch >From 0bf1e6e6b25847ce4bee74487782b82c822138a3 Mon Sep 17 00:00:00 2001 From: Marcin Borkowski 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 --=-=-=--