emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Problem in org-inlinetask-min-level's docstring?


From: Ihor Radchenko
Subject: Re: Problem in org-inlinetask-min-level's docstring?
Date: Fri, 25 Nov 2022 10:33:17 +0000

Alain.Cochard@unistra.fr writes:

> The last paragraph of this docstring is:
>
>    It is strongly recommended that you set ‘org-cycle-max-level’ not
>    at all, or to a number smaller than this one.  In fact, when
>    ‘org-cycle-max-level’ is not set, it will be assumed to be one less
>    than the value of smaller than the value of this variable.
>
> I do not understand the last sentence, even assuming that the 1st 'of'
> is 'or'.   Is my English the problem?

That sentence is indeed screwed up.

Does `org-cycle-max-level' docstring sound better?

    Maximum level which should still be subject to visibility cycling.
    Levels higher than this will, for cycling, be treated as text, not a 
headline.
    When `org-odd-levels-only' is set, a value of N in this variable actually
    means 2N-1 stars as the limiting headline.
    When nil, cycle all levels.
    Note that the limiting level of cycling is also influenced by
    `org-inlinetask-min-level'.  When `org-cycle-max-level' is not set but
    `org-inlinetask-min-level' is, cycling will be limited to levels one less
    than its value.

We may simply replace the faulty sentence with a link to
`org-cycle-max-level' docstring.

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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]