Bug: doc string for "org-end-of-meta-data"

Bug: doc string for "org-end-of-meta-data"

[Tom Davey]

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

Re: Bug: doc string for "org-end-of-meta-data"

[Marco Wahl]

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?

RE: Bug: doc string for "org-end-of-meta-data"

[Tom Davey]

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?

Re: Bug: doc string for "org-end-of-meta-data"

[Marco Wahl]

Hi Tom,

> 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 for the report and the confirmation!

I just committed accordingly.


Bye