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

From: "Tom Davey" <tom@tomdavey.com>
To: "'emacs-org list'" <emacs-orgmode@gnu.org>
Subject: Bug: doc string for "org-end-of-meta-data"
Date: Wed, 15 Sep 2021 14:09:10 -0400	[thread overview]
Message-ID: <014801d7aa5c$c9057450$5b105cf0$@tomdavey.com> (raw)

Hello everybody,

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.

Many thanks to all the developers of Org-mode.  

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

next             reply	other threads:[~2021-09-15 18:42 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-15 18:09 Tom Davey [this message]
2021-09-15 21:04 ` Bug: doc string for "org-end-of-meta-data" Marco Wahl
2021-09-15 22:49   ` Tom Davey
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='014801d7aa5c$c9057450$5b105cf0$@tomdavey.com' \
    --to=tom@tomdavey.com \
    --cc=emacs-orgmode@gnu.org \
    /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).