* 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 00142d87dccd5f83f4faaffaf07aa95823fcc515..af2f3acd4676566e5aa1a6e7cc206cd126347710 100644 (file)
--- 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 0121a78191a24d95b5c591d7c9d658ac4e0fe55c..8512a0e2f976a4382a7a44f98a538a0f1148725e 100644 (file)
--- 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