unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 19461@debbugs.gnu.org
Subject: bug#19461: 25.0.50; doc of `display-buffer-*' functions that take ALIST arg
Date: Sun, 28 Dec 2014 12:50:04 -0800 (PST)	[thread overview]
Message-ID: <97135b13-1c29-44a9-bfd9-f12966e56cd4@default> (raw)


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.

Please describe what ALIST is for, and anything else that might be
important about its value, for each function.  Function doc strings
should describe all parameters.  You can refer to the doc of another
function, if that is appropriate.  But you must not leave users hanging,
with no explanation.



In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'





             reply	other threads:[~2014-12-28 20:50 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-28 20:50 Drew Adams [this message]
2019-08-02 20:44 ` bug#19461: 25.0.50; doc of `display-buffer-*' functions that take ALIST arg 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
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=97135b13-1c29-44a9-bfd9-f12966e56cd4@default \
    --to=drew.adams@oracle.com \
    --cc=19461@debbugs.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.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).