From 524062805b6e9c6687aaacd00ddab5a6cafb3de0 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Wed, 26 Feb 2025 14:52:26 +0200 Subject: [PATCH] ; Fix documentation of 'buffer-text-pixel-size' * doc/lispref/display.texi (Size of Displayed Text): Fix arguments of 'buffer-text-pixel-size'. (Bug#76519) (cherry picked from commit f88dc0f2f9d28d0988cca54c5b9fc1ba85ce3d7e) --- doc/lispref/display.texi | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 7a43e904f98..a1b9772dbe2 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -2377,7 +2377,7 @@ though when this function is run from an idle timer with a delay of zero seconds. @end defun -@defun buffer-text-pixel-size &optional buffer-or-name window from to x-limit y-limit +@defun buffer-text-pixel-size &optional buffer-or-name window x-limit y-limit This is much like @code{window-text-pixel-size}, but can be used when the buffer isn't shown in a window. (@code{window-text-pixel-size} is faster when it is, so this function shouldn't be used in that case.) @@ -2388,10 +2388,14 @@ live window and defaults to the selected one; the function will compute the text dimensions as if @var{buffer} is displayed in @var{window}. The return value is a cons of the maximum pixel-width of any text line and the pixel-height of all the text lines of the -buffer specified by @var{buffer-or-name}. +accessible portion of the buffer specified by @var{buffer-or-name}. The optional arguments @var{x-limit} and @var{y-limit} have the same meaning as with @code{window-text-pixel-size}. + +If you want to measure dimensions of some part of the buffer text, +narrow the buffer to that part before calling this function +(@pxref{Narrowing}). @end defun @defun string-pixel-width string &optional buffer -- 2.39.5