From: martin rudalics <rudalics@gmx.at>
To: Michael Heerdegen <michael_heerdegen@web.de>
Cc: larsi@gnus.org, 19461@debbugs.gnu.org
Subject: bug#19461: 25.0.50; doc of `display-buffer-*' functions that take ALIST arg
Date: Sun, 4 Aug 2019 10:01:05 +0200 [thread overview]
Message-ID: <3a7249b5-a07a-e134-74fb-ca0b5de6aa76@gmx.at> (raw)
In-Reply-To: <87v9vdejia.fsf@web.de>
> I think the docstrings must tell that. Because the names suggest the
> opposite. Something like "this function is for internal use only
Readers might then ask why it does not use the "--" notation.
> - it
> is valid as an action function in the ALIST argument of
> display-buffer
'display-buffer' calls it ACTION argument. A problem with this is
that so far we do not specify what a "valid" action function is.
> ...don't call it directly" or so?
A possible text would be:
"This is an action function for buffer display. It should be called
only by 'display-buffer' or a function directly or indirectly called
by the latter."
Or with a reference to the Elisp manual:
"This is an action function for buffer display, see Info node `(elisp)
Buffer Display Action Functions'. It should be called only by
'display-buffer' or a function directly or indirectly called by the
latter."
> Problematic in this regard is that there _are_ other functions like that
> that are not internal AFAIK - `pop-to-buffer' for example. How can one
> distinguish them?
I see no problems since these would not provide such an explanation.
martin
next prev parent reply other threads:[~2019-08-04 8:01 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-28 20:50 bug#19461: 25.0.50; doc of `display-buffer-*' functions that take ALIST arg Drew Adams
2019-08-02 20:44 ` Lars Ingebrigtsen
2019-08-03 7:58 ` martin rudalics
2019-08-03 9:17 ` Eli Zaretskii
2019-08-03 10:59 ` martin rudalics
2019-08-03 11:02 ` Lars Ingebrigtsen
2019-08-03 11:08 ` Eli Zaretskii
2019-08-04 2:45 ` Michael Heerdegen
2019-08-04 8:01 ` martin rudalics [this message]
2019-08-04 11:18 ` Michael Heerdegen
2019-08-05 9:22 ` martin rudalics
2019-08-04 11:48 ` Lars Ingebrigtsen
2019-08-04 12:13 ` Michael Heerdegen
2019-08-04 15:39 ` Eli Zaretskii
2019-08-05 9:23 ` martin rudalics
2021-09-25 16:12 ` Stefan Kangas
2021-09-26 9:11 ` martin rudalics
2021-09-26 9:34 ` Stefan Kangas
2019-08-05 1:06 ` Drew Adams
2019-08-05 9:23 ` martin rudalics
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=3a7249b5-a07a-e134-74fb-ca0b5de6aa76@gmx.at \
--to=rudalics@gmx.at \
--cc=19461@debbugs.gnu.org \
--cc=larsi@gnus.org \
--cc=michael_heerdegen@web.de \
/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.