emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: "Tom Davey" <tom@tomdavey.com>
To: "'Marco Wahl'" <marcowahlsoft@gmail.com>
Cc: 'emacs-org list' <emacs-orgmode@gnu.org>
Subject: RE: Bug: doc string for "org-end-of-meta-data"
Date: Wed, 15 Sep 2021 18:49:36 -0400	[thread overview]
Message-ID: <015b01d7aa83$f6ee0270$e4ca0750$@tomdavey.com> (raw)
In-Reply-To: <87ilz1360m.fsf@gmail.com>

Hi Marco, 

You make sense. What you propose to substitute is easier to understand and
concise: 

     When FULL is non-nil but not t, skip planning information, 
     properties, clocking lines and logbook drawers.

Thank you! 

--
Tom Davey
tom@tomdavey.com
New York NY USA

-----Original Message-----
From: Marco Wahl <marcowahlsoft@gmail.com> 
Sent: Wednesday, September 15, 2021 5:04 PM
To: Tom Davey <tom@tomdavey.com>
Cc: 'emacs-org list' <emacs-orgmode@gnu.org>
Subject: Re: Bug: doc string for "org-end-of-meta-data"

Hello Tom,

> I believe the last paragraph of the doc string for the function 
> "org-end-of-meta-data" contains an error. That one-sentence paragraph 
> currently reads:
>
>     When FULL is non-nil but not t, skip planning information, 
>     clocking lines and only non-regular drawers, i.e. properties 
>     and logbook drawers.
>
> I believe that should be "regular drawers," not "non-regular drawers." 
> IMO, the last paragraph could be clearer were it rewritten as follows:
>
>    When FULL is non-nil but not t, skip only planning information, 
>    clocking lines and regular drawers, i.e. properties and logbook 
>    drawers. If any non-regular drawers exist and do not follow the 
>    two regular drawers, stop at the first non-regular drawer instead.
>
> I believe that this expansion of the paragraph corrects the error and 
> adds coverage of a rare case.

I think the use of the word "regular" is not a good idea in their
documentation of org-end-of-meta-data.  I could not find any occurance of
the term "regular drawer" in the org-info manual.  There is a section where
the property drawer is called "special".

In conclusion I'd say that the logic of the recent documentation is okay
with "regular" meaning "non-special".

Finally I propose to remove completely the categorisation due to "regular"
from the documentation.  Which reads:

     When FULL is non-nil but not t, skip planning information, 
     properties, clocking lines and logbook drawers.

WDYT?

next prev parent reply	other threads:[~2021-09-15 22:50 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-15 18:09 Bug: doc string for "org-end-of-meta-data" Tom Davey
2021-09-15 21:04 ` Marco Wahl
2021-09-15 22:49   ` Tom Davey [this message]
2021-09-16  8:51     ` Marco Wahl

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='015b01d7aa83$f6ee0270$e4ca0750$@tomdavey.com' \
    --to=tom@tomdavey.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=marcowahlsoft@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

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