From: Ihor Radchenko <yantar92@posteo.net>
To: Matt <matt@excalamus.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable)
Date: Fri, 05 Jan 2024 13:17:41 +0000 [thread overview]
Message-ID: <87zfxj6hsa.fsf@localhost> (raw)
In-Reply-To: <18cd111777e.efad32b9285772.6378361649896083029@excalamus.com>
Matt <matt@excalamus.com> writes:
> ---- On Wed, 03 Jan 2024 14:41:29 +0100 Ihor Radchenko wrote ---
>
> > I do not see much benefit changing "todo list" to "to-do list". Both are
> > clear and both are grammatically correct.
>
> I said "TODO" to "to-do". I was reacting to it being all caps. I'm sorry I didn't say that.
>
> When it's all caps, TODO is a keyword. Otherwise, it's prose. The following are different (AFAIK):
>
> * TODO Finish this headline
> * todo Finish this headline
> * to-do Finish this headline
>
> Agreed, it's a minor detail.
Yeah. TODO may be a bit funny. Although, we consistently use "TODO list"
across the manual and often say something like "list of all TODO items",
which is resonant with the concept of TODO keywords in Org mode.
So, TODO in caps actually make some sense within the context of Org
manual. You can call it a style.
Unless I hear from people being seriously confused by "TODO" in caps, I
am inclined to keep the existing style convention.
> ...
> "Markup language" is fine. It's correct. Org syntax is a markup language.
>
> I'm happy to leave it rather than risk bike-shedding it more than I have. If we learn that it caused friction for a newcomer, we can change it easily enough.
+1
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2024-01-05 13:15 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-31 15:24 [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable Ihor Radchenko
2024-01-02 5:24 ` Thomas S. Dye
2024-01-03 7:52 ` Jean Louis
2024-01-03 12:36 ` Bastien Guerry
2024-01-03 13:00 ` Ihor Radchenko
2024-01-02 22:47 ` Matt
2024-01-03 13:44 ` Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable) Ihor Radchenko
2024-01-03 20:43 ` Matt
2024-01-05 13:17 ` Ihor Radchenko [this message]
2024-01-05 13:06 ` [PATCH v2] doc/org-manual.org (Summary): Clarify the Org markup is human-readable Ihor Radchenko
2024-01-06 10:31 ` Matt
2024-01-06 12:55 ` Ihor Radchenko
2024-01-06 12:56 ` Matt
2024-02-01 12:16 ` Ihor Radchenko
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=87zfxj6hsa.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=matt@excalamus.com \
/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).