From: Juri Linkov <juri@linkov.net>
Date: Thu, 2 Apr 2020 21:50:19 +0000 (+0300)
Subject: * lisp/window.el (display-buffer): Extend doc with body-function (bug#39822)
X-Git-Tag: emacs-28.0.90~7675
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=bb729496f9b699896fed8d65bf499a193a7c4886;p=emacs.git

* lisp/window.el (display-buffer): Extend doc with body-function (bug#39822)
---

diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 00142d87dcc..af2f3acd467 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -3053,10 +3053,11 @@ action function that cares about this entry.
 @item body-function
 The value must be a function taking one argument (a displayed window).
 This function can be used to fill the displayed window's body with
-some contents.  It is called @emph{after} the buffer is displayed, and
-@emph{before} the entries @code{window-height}, @code{window-width}
-and @code{preserve-size} are applied that could resize the window
-to fit it to the inserted contents.
+some contents that might depend on dimensions of the displayed window.
+It is called @emph{after} the buffer is displayed, and @emph{before}
+the entries @code{window-height}, @code{window-width} and
+@code{preserve-size} are applied that could resize the window to fit
+it to the inserted contents.
 @end table
 
 By convention, the entries @code{window-height}, @code{window-width}
diff --git a/lisp/window.el b/lisp/window.el
index 0121a78191a..8512a0e2f97 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -7405,6 +7405,12 @@ Action alist entries are:
     parameters to give the chosen window.
  `allow-no-window' -- A non-nil value means that `display-buffer'
     may not display the buffer and return nil immediately.
+ `body-function' -- A function called with one argument - the
+    displayed window.  It is called after the buffer is
+    displayed, and before `window-height', `window-width'
+    and `preserve-size' are applied.  The function is supposed
+    to fill the window body with some contents that might depend
+    on dimensions of the displayed window.
 
 The entries `window-height', `window-width' and `preserve-size'
 are applied only when the window used for displaying the buffer