Re: [PATCH v2] Documentation: Use grid table over list table

[Jonathan Corbet]

Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx> writes:

> On Fri, 06 Sep 2024, Takahiro Itazuri <itazur@xxxxxxxxxx> wrote:
>> Using a simple table, a line break in the first column would be
>> recognized as two rows. To avoid that, list table was used but it
>> is unreadable for plain text readers. Uses grid table instead.
>>
>> Signed-off-by: Takahiro Itazuri <itazur@xxxxxxxxxx>
>> ---
>> Changes in v2:
>> - Use grid table over list table (applying to not only GDS but also
>>   other vulnerabilities)
>> - Link to v1: https://lore.kernel.org/all/20240903132533.26458-1-itazur@xxxxxxxxxx/
>
> I see that Jon asked you to use a grid table.
>
> But when I look at what's being changed, I can't help but think a
> definition list [1] might provide the best compromise between readable
> (and easily editable!) source rst and generated html. I don't think it
> has to be a *table* in either.
>
> Up to Jon, of course.

I think it's up to the people who write and use the documentation in the
end; I don't want to dictate minor choices like that.  Anything that
makes it more readable works well for me.

Thanks,

jon