From: Jonathan Corbet <corbet@lwn.net>
To: Joe Stringer <joe@isovalent.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH linux-doc] docs/doc-guide: Clarify how to write tables
Date: Tue, 14 Mar 2023 12:14:10 -0600 [thread overview]
Message-ID: <87r0trryj1.fsf@meer.lwn.net> (raw)
In-Reply-To: <CADa=RyzQmTEFnpKehGoKihmz+EniibjWQ0P12XMwqgqQ8UcO-w@mail.gmail.com>
Joe Stringer <joe@isovalent.com> 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
next prev parent reply other threads:[~2023-03-14 18:14 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-12 20:17 [PATCH linux-doc] docs/doc-guide: Clarify how to write tables Joe Stringer
2023-03-12 20:24 ` Jonathan Corbet
2023-03-12 21:11 ` Joe Stringer
2023-03-14 18:14 ` Jonathan Corbet [this message]
2023-03-16 1:55 ` Joe Stringer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r0trryj1.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=joe@isovalent.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox