emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Samuel Wales <samologist@gmail.com>
To: Marcin Borkowski <mbork@mbork.pl>
Cc: emacs-orgmode@gnu.org, Nicolas Goaziou <mail@nicolasgoaziou.fr>
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 12:29:04 -0700	[thread overview]
Message-ID: <CAJcAo8u2FAcess+-ag9+t09Y58jjp49jFkDJb+j2qju0Td_atA@mail.gmail.com> (raw)
In-Reply-To: <87wohck0jf.fsf@mbork.pl>

this looks good, but i wonder if newcomers get confused about that todo thing.

i am not proposing any solution, just brainstorming.

the word todo is used in a few contexts in org:

  - the todo keyword per se [TODO]
  - todoish keywords as opposed to doneish keywords
  - the global todo view as opposed to the general views that cover
time [called daily/weekly], structured search [called tags], and
free-form search [called search]

newcomers might wonder if the global todo view does anything that the
general views cannot do, otherwise why does it exist.

some newcomers might even wonder if todo means keyword as opposed to blank.

don't take this too seriously, but i wonder if that todo- confuses
newcomers even though the docstring is now clear.


On 6/23/19, 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.
>
> WDYT?
>
> --
> Marcin Borkowski
> http://mbork.pl
>


-- 
The Kafka Pandemic

What is misopathy?
https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html

The disease DOES progress. MANY people have died from it. And ANYBODY
can get it at any time.

  reply	other threads:[~2019-06-23 19:29 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
2019-06-23 19:29     ` Samuel Wales [this message]
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=CAJcAo8u2FAcess+-ag9+t09Y58jjp49jFkDJb+j2qju0Td_atA@mail.gmail.com \
    --to=samologist@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=mail@nicolasgoaziou.fr \
    --cc=mbork@mbork.pl \
    /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).