summaryrefslogtreecommitdiff
path: root/doc/lispref/display.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2023-08-03 08:31:17 +0300
committerEli Zaretskii <eliz@gnu.org>2023-08-03 08:31:17 +0300
commit6eddbfe33f2ff07f186da14f8974e742bf3ca2ae (patch)
treea65d1b14e11fb0d9171998ee5604565989ada482 /doc/lispref/display.texi
parent5c6a51668b0917aa1e014cbfa7bfcf703a4e7048 (diff)
downloademacs-6eddbfe33f2ff07f186da14f8974e742bf3ca2ae.tar.gz
emacs-6eddbfe33f2ff07f186da14f8974e742bf3ca2ae.tar.bz2
emacs-6eddbfe33f2ff07f186da14f8974e742bf3ca2ae.zip
Clarify the meaning of the argument of ':align-to' space spec
* doc/lispref/display.texi (Specified Space): Clarify the meaning and measurement of HPOS in ':align-to' space specs. (Bug#65015)
Diffstat (limited to 'doc/lispref/display.texi')
-rw-r--r--doc/lispref/display.texi16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index e229935170f..50a91066d1d 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -5287,10 +5287,18 @@ the ``pixel width'' of a character is usually 1, but it could be more
for TABs and double-width CJK characters.)
@item :align-to @var{hpos}
-Specifies that the space should be wide enough to reach @var{hpos}.
-If @var{hpos} is a number, it is measured in units of the normal
-character width. @var{hpos} can also be a @dfn{pixel width}
-specification (@pxref{Pixel Specification}).
+Specifies that the space should be wide enough to reach the column
+@var{hpos}. If @var{hpos} is a number, it is a column number, and is
+measured in units of the canonical character width (@pxref{Frame
+Font}). @var{hpos} can also be a @dfn{pixel width} specification
+(@pxref{Pixel Specification}). When the current line is wider than
+the window, and is either displayed by one or more continuation lines,
+or is truncated and possibly scrolled horizontally (@pxref{Horizontal
+Scrolling}), @var{hpos} is measured from the beginning of the logical
+line, not from the visual beginning of the screen line. This way,
+alignment produced by @code{:align-to} is consistent with functions
+that count columns, such as @code{current-column} and
+@code{move-to-column} (@pxref{Columns}).
@end table
You should use one and only one of the above properties. You can