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 20:44:12 +0200

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

On Sat, May 25 2024, Joost Kremers wrote:
> On Fri, May 24 2024, Eli Zaretskii wrote:
>> It's better, but I think it will be even more clear if you make a
>> @table out of the 3 possible forms of the 'width' slot.
>
> That's a tough one. :D Here's what I came up with:

Apologies, noticed a typo right after sending... Here's a corrected patch:

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

From 42de82abd54ca290048553d4d073df0086577367 Mon Sep 17 00:00:00 2001
From: Joost Kremers <joostkremers <at> fastmail.com>
Date: Sat, 25 May 2024 20:38:22 +0200
Subject: [PATCH] Update documentation for 'width' slot of vtable ':columns'
 object.

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

diff --git a/doc/misc/vtable.texi b/doc/misc/vtable.texi
index 7252c61b9d2..3bd06a7f5a1 100644
--- a/doc/misc/vtable.texi
+++ b/doc/misc/vtable.texi
@@ -281,11 +281,18 @@ 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{@var{x}ex}, where @var{x} is a number of @samp{x} characters, or a
-string on the form @samp{@var{x}px} (denoting a number of pixels), or a
-string on the form @samp{@var{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} or 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}
+A width of @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.