procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Fix documentation of 'buffer-text-pixel-size'

Browse source 
* doc/lispref/display.texi (Size of Displayed Text): Fix arguments
of 'buffer-text-pixel-size'.  (Bug#76519)
This commit is contained in:
Eli Zaretskii 2025-02-26 14:52:26 +02:00
parent 734986349f
commit f88dc0f2f9
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/lispref/display.texi
View file

@ -2377,7 +2377,7 @@ though when this function is run from an idle timer with a delay of zero
seconds. seconds.
@end defun @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 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 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.) 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 compute the text dimensions as if @var{buffer} is displayed in
@var{window}. The return value is a cons of the maximum pixel-width @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 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 The optional arguments @var{x-limit} and @var{y-limit} have the same
meaning as with @code{window-text-pixel-size}. 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 @end defun
@defun string-pixel-width string @defun string-pixel-width string