Re: Comments on Summary section of Org manual (was: [PATCH] doc/org-manual.org (Summary): Clarify the Org markup is human-readable)

[Ihor Radchenko]

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>