Re: [PATCH linux-doc] docs/doc-guide: Clarify how to write tables

From: Jonathan Corbet
Date: Tue Mar 14 2023 - 14:14:18 EST


Joe Stringer <joe@xxxxxxxxxxxxx> writes:

>> ...and if they do merit an exception, why would we prefer the full grid
>> format (which is harder to create and maintain) than the simple table
>> format? Most of the time, the simple format can do what's needed, and I
>> don't think it's less readable.
>
> I'm not opinionated about grid format, I just picked one. But this is
> interesting - If simple table is the preferred format, then that
> sounds like the sort of detail that this docs page should communicate.
> For example:

I think that either format is fine, both are readable. I just
questioned whether we should push people toward the grid format, which
takes more effort to create, in the absence of a reason to do so.

Thanks,

jon