From: Marcin Borkowski <mbork@mbork.pl>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode@gnu.org
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: Sun, 23 Jun 2019 13:23:48 +0200 [thread overview]
Message-ID: <87wohck0jf.fsf@mbork.pl> (raw)
In-Reply-To: <87d0j9pelr.fsf@nicolasgoaziou.fr>
[-- Attachment #1: Type: text/plain, Size: 995 bytes --]
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.
WDYT?
--
Marcin Borkowski
http://mbork.pl
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Make-two-docstrings-more-clear.patch --]
[-- Type: text/x-patch; size=1.79KiB, Size: 1833 bytes --]
From d5a1c1ff3a9a7ccbf2765332971973b2c4233e16 Mon Sep 17 00:00:00 2001
From: Marcin Borkowski <mbork@mbork.pl>
Date: Sun, 23 Jun 2019 13:22:04 +0200
Subject: [PATCH] Make two docstrings more clear
The docstrings of `org-agenda-todo-ignore-with-date` and
`org-agenda-todo-ignore-timestamp` were not very clear. Now they are
better.
---
lisp/org-agenda.el | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index fbf520c5e..daf51601d 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -690,9 +690,10 @@ potentially much shorter TODO lists."
"Non-nil means don't show entries with a date in the global todo list.
You can use this if you prefer to mark mere appointments with a TODO keyword,
but don't want them to show up in the TODO list.
-When this is set, it also covers deadlines and scheduled items, the settings
-of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
-will be ignored.
+When this is set, it also covers deadlines and scheduled items
+(more precisely, every entry with at least one active timestamp will be ignored),
+the settings of `org-agenda-todo-ignore-scheduled'
+and `org-agenda-todo-ignore-deadlines' will be ignored.
See also the variable `org-agenda-tags-todo-honor-ignore-options'."
:group 'org-agenda-skip
:group 'org-agenda-todo-list
@@ -700,6 +701,9 @@ See also the variable `org-agenda-tags-todo-honor-ignore-options'."
(defcustom org-agenda-todo-ignore-timestamp nil
"Non-nil means don't show entries with a timestamp.
+If this variable is non-nil, Org agenda looks at the first active
+timestamp in the entry which is neither a DEADLINE nor
+a SCHEDULED timestamp and compares it to \"today\".
This applies when creating the global todo list.
Valid values are:
--
2.22.0
next prev parent reply other threads:[~2019-06-23 11:30 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-18 6:55 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
2019-06-19 19:19 ` Nicolas Goaziou
2019-06-23 11:23 ` Marcin Borkowski [this message]
2019-06-23 19:29 ` Samuel Wales
2019-06-24 19:08 ` Marcin Borkowski
2019-06-24 19:09 ` Marcin Borkowski
2019-07-07 7:51 ` Marcin Borkowski
2019-07-09 10:22 ` Nicolas Goaziou
2019-07-11 19:06 ` Marcin Borkowski
2019-07-12 8:53 ` Nicolas Goaziou
2019-07-14 20:30 ` Marcin Borkowski
2019-07-14 22:00 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wohck0jf.fsf@mbork.pl \
--to=mbork@mbork.pl \
--cc=emacs-orgmode@gnu.org \
--cc=mail@nicolasgoaziou.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).