aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii2011-11-04 12:09:41 +0200
committerEli Zaretskii2011-11-04 12:09:41 +0200
commit89bd5ee15acb93aefd403f3c76d1aff57520608b (patch)
treef0b75789124fd62789f8642eec80b97c82c01fe1 /doc
parent56c31147dce7a3b3c40792be5b115a2e6dbcfe1d (diff)
downloademacs-89bd5ee15acb93aefd403f3c76d1aff57520608b.tar.gz
emacs-89bd5ee15acb93aefd403f3c76d1aff57520608b.zip
Fix documentation per bug #9949.
src/window.c (Fwindow_body_size): Mention in the doc string that the return value is in frame's canonical units. lisp/window.el (window-body-height, window-body-width): Mention in the doc string that the return values are in frame's canonical units. doc/lispref/windows.texi (Window Sizes): Mention in the doc string that the return values of `window-body-height' and `window-body-width' are in frame's canonical units.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/windows.texi14
2 files changed, 18 insertions, 2 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 1e86e07998c..2da562bdcfb 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,9 @@
12011-11-04 Eli Zaretskii <eliz@gnu.org>
2
3 * windows.texi (Window Sizes): Mention in the doc string that the
4 return values of `window-body-height' and `window-body-width' are
5 in frame's canonical units. (Bug#9949)
6
12011-10-30 Martin Rudalics <rudalics@gmx.at> 72011-10-30 Martin Rudalics <rudalics@gmx.at>
2 8
3 * windows.texi (Windows and Frames): Remove "iso-" infix from 9 * windows.texi (Windows and Frames): Remove "iso-" infix from
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 37679aa4a0b..bd20f5d8f44 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -563,8 +563,18 @@ window's body width.
563 563
564@cindex body size of a window 564@cindex body size of a window
565@cindex window body size 565@cindex window body size
566The following functions retrieve height and width of the body of a live 566@cindex canonical units of window/frame size
567window: 567The following functions retrieve height and width of the body of a
568live window. Note that the values these functions return are measured
569in @dfn{canonical units}, i.e.@: for the default frame's face. If the
570window shows some characters with non-default face, e.g., if the font
571of some characters is larger or smaller than the default font, the
572values returned by these functions will not match the actual number of
573lines or characters per line shown in the window. To get the actual
574number of columns and lines, move to the last character in the line
575(e.g., with @code{end-of-visual-line}) or to the last line of the
576window (e.g., with @code{window-end}), and use @code{posn-at-point} to
577find the line or column there.
568 578
569@defun window-body-size &optional window horizontal 579@defun window-body-size &optional window horizontal
570This function returns the number of lines of @var{window}'s text area. 580This function returns the number of lines of @var{window}'s text area.