From: Eli Zaretskii <eliz@gnu.org>
To: Matthias Meulien <orontee@gmail.com>, Juri Linkov <juri@linkov.net>
Cc: emacs-devel@gnu.org
Subject: Re: Extend Outline mode with default visibility state
Date: Sun, 16 Jan 2022 20:42:07 +0200 [thread overview]
Message-ID: <8335lny134.fsf@gnu.org> (raw)
The doc string of outline-default-state "Needs Work":
(defcustom outline-default-state nil
"If non-nil, some headings are initially outlined.
Note that the default state is applied when the major mode is set
or when the command `outline-apply-default-state' is called
interactively.
What major mode does this allude to?
When nil, headings visibility is left unchanged.
Unchanged from what state?
If equal to `outline-show-all', all text of buffer is shown.
If equal to `outline-show-only-headings', only headings are shown.
What does "headings" mean here? Does it mean headings off all the
levels, or just of the top level, or something else?
If equal to a number, show only headings up to and including the
corresponding level. See `outline-default-rules' to customize
visibility of the subtree at the choosen level.
Is `outline-default-rules' relevant only to that single value of
outline-default-state?
If equal to a lambda function or function name, this function is
expected to toggle headings visibility, and will be called after
the mode is enabled."
This doesn't say whether the function is called with any arguments.
The doc string of outline-default-rules also "Needs Work":
(defcustom outline-default-rules nil
"Determines visibility of subtree starting at `outline-default-state' level.
If this is only relevant to a single value of outline-default-state,
the doc string should say so.
- A lambda function or function name which will be evaluated with
point at the beginning of the heading and the match data set
appropriately, the function being expected to toggle the
heading visibility."
This should tell what arguments, if any, the function is called.
Also, "function ... will be evaluated" is not our style.
Can these issues be fixed, please?
Thanks.
next reply other threads:[~2022-01-16 18:42 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-16 18:42 Eli Zaretskii [this message]
2022-01-16 19:21 ` Extend Outline mode with default visibility state Eli Zaretskii
2022-01-17 19:35 ` Matthias Meulien
2022-01-17 19:58 ` Stefan Monnier
2022-01-17 19:34 ` Matthias Meulien
2022-01-20 11:37 ` Eli Zaretskii
2022-01-21 20:54 ` Matthias Meulien
2022-01-22 11:54 ` Eli Zaretskii
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8335lny134.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=juri@linkov.net \
--cc=orontee@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
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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.