unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: martin rudalics <rudalics@gmx.at>
To: Lars Ingebrigtsen <larsi@gnus.org>, Drew Adams <drew.adams@oracle.com>
Cc: 19461@debbugs.gnu.org
Subject: bug#19461: 25.0.50; doc of `display-buffer-*' functions that take ALIST arg
Date: Sat, 3 Aug 2019 09:58:18 +0200	[thread overview]
Message-ID: <b6ad3d9c-ac85-a850-ed53-c8b5ce58e515@gmx.at> (raw)
In-Reply-To: <8736ijmh50.fsf@mouse.gnus.org>

 >> The doc strings say nothing about parameter ALIST, which in many cases
 >> is the most important parameter.
 >>
 >> One can guess that it is an alist.  And one can guess, for the doc
 >> strings that mention `inhibit-switch-frame' or
 >> `pop-up-frame-parameters', that one or more of its entries can have such
 >> a key, but that's all.  No guessing helps for
 >> `display-buffer-(below-selected|at-bottom|in-previous-window|
 >> use-some-window|no-window|same-window|assq-regexp)'.  Likewise, some of
 >> the "internal" functions.
 >
 > It is indeed pretty obscure what ALIST is.

This problem is with us since day one of that buffer display code.
It's probably due to the fact that the 'display-buffer-*' functions
are inherently internal but never have been marked as such in order to
describe them in the manual and allow users to add new ones.

 > Some of the functions say
 > things like
 >
 > ---
 > If ALIST contains a ’window-min-height’ entry, this function
 > ensures that the window used is or can become at least as high as
 > specified by that entry’s value.
 > ---
 >
 > but looking at the code, it passes ALIST around a lot.  So is ALIST a
 > general buffer/window property thing?

 > At least one of these doc strings
 > should say what it is, and the rest could refer to it.

Saying what it is is non-trivial, see section 28.13.3 of the Elisp
manual.  So I have no good idea how to do what you propose.

martin






  reply	other threads:[~2019-08-03  7:58 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 [this message]
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
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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b6ad3d9c-ac85-a850-ed53-c8b5ce58e515@gmx.at \
    --to=rudalics@gmx.at \
    --cc=19461@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=larsi@gnus.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.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).