[Emacs-diffs] /srv/bzr/emacs/trunk r107258: * lisp/window.el (display-buffer): Doc fix.

[Chong Yidong]

------------------------------------------------------------
revno: 107258
fixes bug(s): http://debbugs.gnu.org/10785
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Sun 2012-02-12 13:10:30 +0800
message:
  * lisp/window.el (display-buffer): Doc fix.
modified:
  lisp/ChangeLog
  lisp/window.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-02-12 03:13:13 +0000
+++ b/lisp/ChangeLog    2012-02-12 05:10:30 +0000
@@ -1,3 +1,7 @@
+2012-02-12  Chong Yidong  <address@hidden>
+
+       * window.el (display-buffer): Doc fix (Bug#10785).
+
 2012-02-12  Glenn Morris  <address@hidden>
 
        * term/pc-win.el (x-selection-owner-p, x-own-selection-internal)

=== modified file 'lisp/window.el'
--- a/lisp/window.el    2012-02-11 22:13:29 +0000
+++ b/lisp/window.el    2012-02-12 05:10:30 +0000
@@ -4625,16 +4625,20 @@
 or nil if no such window is found.
 
 Optional argument ACTION should have the form (FUNCTION . ALIST).
-FUNCTION is either a function or a list of functions.  Each such
-function is called with two arguments: the buffer to display and
-an alist.  It should either display the buffer and return the
-window, or return nil if unable to display the buffer.
+FUNCTION is either a function or a list of functions.
+ALIST is an arbitrary association list (alist).
+
+Each such FUNCTION should accept two arguments: the buffer to
+display and an alist.  Based on those arguments, it should either
+display the buffer and return the window, or return nil if unable
+to display the buffer.
 
 The `display-buffer' function builds a function list and an alist
-from `display-buffer-overriding-action', `display-buffer-alist',
-the ACTION argument, `display-buffer-base-action', and
-`display-buffer-fallback-action' (in that order).  Then it calls
-each function in the combined function list in turn, passing the
+by combining the functions and alists specified in
+`display-buffer-overriding-action', `display-buffer-alist', the
+ACTION argument, `display-buffer-base-action', and
+`display-buffer-fallback-action' (in order).  Then it calls each
+function in the combined function list in turn, passing the
 buffer as the first argument and the combined alist as the second
 argument, until one of the functions returns non-nil.