emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: Matt <matt@excalamus.com>
Cc: "Sławomir Grochowski" <slawomir.grochowski@gmail.com>,
	emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' from 'TODO Items' to 'Plain Lists'
Date: Wed, 28 Feb 2024 12:20:57 +0000	[thread overview]
Message-ID: <87le743hli.fsf@localhost> (raw)
In-Reply-To: <18deb76f2d9.cad957fe1073948.9203602429479305690@excalamus.com>

Matt <matt@excalamus.com> writes:

> I had responded in favor here: https://list.orgmode.org/18d4cf138a6.10fb9c6702382826.5023996590743168415@excalamus.com/

Did I miss something, or did you not provided arguments /why/ the
section should be moved? I need to understand what kind of improvement
it would provide to the manual.

> The Checkboxes section is written assuming the reader knows what Properties are.  The GNU documentation guidelines suggest writing as though readers have read from the beginning [fn:1] [fn:2].  That is, unless introducing a concept, only use concepts that have already been explained.  Properties are introduced in Section 2.7 and Checkboxes is currently 5.6.   The proposal is to move Checkboxes to 2.6.1 *before* properties are introduced.  This is a problem.

We start talking about properties as early as in 2.2.2 Initial
visibility and in many other places. Re-ordering the manual to avoid
referring to future concepts would entail a major rewrite.

-- 
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>


  parent reply	other threads:[~2024-02-28 12:17 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-25 13:05 [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' from 'TODO Items' to 'Plain Lists' Sławomir Grochowski
2024-01-25 22:36 ` Ihor Radchenko
2024-02-26  8:59   ` Ihor Radchenko
2024-02-27 16:47     ` Matt
2024-02-27 23:07       ` Sławomir Grochowski
2024-02-28 12:20       ` Ihor Radchenko [this message]
2024-02-28 19:10         ` Matt
2024-03-02 12:43           ` Ihor Radchenko
2024-08-20 10:45             ` Carsten Dominik

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=87le743hli.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=matt@excalamus.com \
    --cc=slawomir.grochowski@gmail.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).