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

From: Joe Stringer
Date: Wed Mar 15 2023 - 21:56:00 EST


On Tue, Mar 14, 2023 at 11:14 AM Jonathan Corbet <corbet@xxxxxxx> wrote:
>
> 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.

Got it, thanks Jon. I'll spin a v2.