(window-full-height-p): Add doc string.

2 files changed, 8 insertions, 0 deletions

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 441fd7d47ec..eeb3770db6b 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2009-10-04  Glenn Morris  <rgm@gnu.org>
+
+        * window.el (window-full-height-p): Add doc string.
+
 2009-10-04  Martin Rudalics  <rudalics@gmx.at>
 
         * window.el (window-full-height-p): New function.  (Bug#4543)
diff --git a/lisp/window.el b/lisp/window.el
index 9339247bfa8..c4dc973f94f 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -87,7 +87,11 @@ return value, use `window-text-height' instead."
                 (if mode-line-format 1 0)
                 (if header-line-format 1 0))))))
 
+;; See discussion in bug#4543.
 (defun window-full-height-p (&optional window)
+  "Return non-nil if WINDOW is not the result of a vertical split.
+WINDOW defaults to the selected window.  (This function is not
+appropriate for minibuffers.)"
   (unless window
     (setq window (selected-window)))
   (= (window-height window)