emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: alain.cochard@unistra.fr
Cc: Org Mode List <emacs-orgmode@gnu.org>
Subject: Re: Problem in org-inlinetask-min-level's docstring?
Date: Fri, 25 Nov 2022 10:33:17 +0000	[thread overview]
Message-ID: <87fse79vde.fsf@localhost> (raw)
In-Reply-To: <25472.37887.71738.229098@gargle.gargle.HOWL>

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	other threads:[~2022-11-25 10:33 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-25 10:07 Problem in org-inlinetask-min-level's docstring? Alain.Cochard
2022-11-25 10:33 ` Ihor Radchenko [this message]
2022-12-12 12:33   ` Alain.Cochard
2022-12-13  7:33     ` Ihor Radchenko
2022-12-13  7:36     ` [BUG] org-cycle-max-level is broken, especially when using org-element-cache (was: Problem in org-inlinetask-min-level's docstring?) Ihor Radchenko
2022-12-13  8:37       ` Alain.Cochard

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=87fse79vde.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=alain.cochard@unistra.fr \
    --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
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).