(frame-height): Doc fix.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 35362f1f4e42629e354d7306ca54a90e70b01d41..06eb7c9acb44c4208ffef9e5655471a20cc7d0cf 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -16,6 +16,8 @@
 
 2009-10-10  Glenn Morris  <rgm@gnu.org>
 
+       * frame.el (frame-height): Doc fix.
+
        * calendar/calendar.el (calendar-split-width-threshold): New option.
        (calendar-basic-setup): Use calendar-split-width-threshold.
 

diff --git a/lisp/frame.el b/lisp/frame.el
index e5d92fa1df3b33c517ff918cd621df8a4f9942c4..91619ce62fdbd6dbe5a6688fba3975ab972a0ea9 100644 (file)
--- a/lisp/frame.el
+++ b/lisp/frame.el
@@ -1,7 +1,7 @@
 ;;; frame.el --- multi-frame management independent of window systems
 
 ;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2002, 2003,
-;;   2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+;;   2004, 2005, 2006, 2007, 2008, 2009  Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: internal
@@ -1027,7 +1027,16 @@ is given and non-nil, the unwanted frames are iconified instead."
 
 (defun frame-height (&optional frame)
   "Return number of lines available for display on FRAME.
-If FRAME is omitted, describe the currently selected frame."
+If FRAME is omitted, describe the currently selected frame.
+Exactly what is included in the return value depends on the
+window-system and toolkit in use - see `frame-pixel-height' for
+more details.  The lines are in units of the default font height.
+
+The result is roughly related to the frame pixel height via
+height in pixels = height in lines * `frame-char-height'.
+However, this is only approximate, and is complicated e.g. by the
+fact that individual window lines and menu bar lines can have
+differing font heights."
   (cdr (assq 'height (frame-parameters frame))))
 
 (defun frame-width (&optional frame)