GNU bug report logs - #71167
29.3; vtable: documentation bug

Previous Next

Full log

View this message in rfc822 format

From: Joost Kremers <joostkremers <at> fastmail.fm>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 71167 <at> debbugs.gnu.org
Subject: bug#71167: 29.3; vtable: documentation bug
Date: Sat, 25 May 2024 22:05:26 +0200

[Message part 1 (text/plain, inline)]

On Sat, May 25 2024, Eli Zaretskii wrote:
> This could be improved:
>
>   @item a number @var{n}
>   @itemx a string of the form @samp{@var{n}ex}

Done.

>> +@item a string of the form @samp{@var{n}px}
>> +A width of @var{n} pixels.
>    ^^^^^^^
> "The width", I guess?  Or maybe just "@var{n} pixels"?

"@var{n} pixels" seems best, I think.

[0001-Update-documentation-for-width-slot-of-vtable-column.patch (text/x-patch, inline)]

From f2df6460e90b9a6eb561026343c193e428189e08 Mon Sep 17 00:00:00 2001
From: Joost Kremers <joostkremers <at> fastmail.com>
Date: Sat, 25 May 2024 21:55:29 +0200
Subject: [PATCH] Update documentation for 'width' slot of vtable ':column'
 object

---
 doc/misc/vtable.texi | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/doc/misc/vtable.texi b/doc/misc/vtable.texi
index 822b1097cd9..6003435385f 100644
--- a/doc/misc/vtable.texi
+++ b/doc/misc/vtable.texi
@@ -281,11 +281,19 @@ Making A Table
 The name of the column.
 
 @item width
-The width of the column.  This is either a number (the width of that
-many @samp{x} characters in the table's face), or a string on the form
-@samp{Xe <at> var{x}}, where @var{x} is a number of @samp{x} characters, or a
-string on the form @samp{Xp <at> var{x}} (denoting a number of pixels), or a
-string on the form @samp{X%} (a percentage of the window's width).
+The width of the column.  This can be one of the following:
+
+@table @asis
+@item a number @var{n}
+@itemx a string of the form @samp{@var{n}ex}
+The width of @var{n} @samp{x} characters in the table's face.
+
+@item a string of the form @samp{@var{n}px}
+@var{n} pixels.
+
+@item a string of the form @samp{@var{n}%}
+@var{n} percent of the window's width.
+@end table
 
 @item min-width
 This uses the same format as @code{width}, but specifies the minimum
-- 
2.45.1

[Message part 3 (text/plain, inline)]

-- 
Joost Kremers
Life has its moments

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.