public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Joe Stringer <joe@isovalent.com>, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Subject: Re: [PATCH linux-doc v3] docs/doc-guide: Clarify how to write tables
Date: Fri, 09 Jun 2023 01:58:35 -0600	[thread overview]
Message-ID: <87mt19oyms.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230424171850.3612317-1-joe@isovalent.com>

Joe Stringer <joe@isovalent.com> writes:

> Prior to this commit, the kernel docs writing guide spent over a page
> describing exactly how *not* to write tables into the kernel docs,
> without providing a example about the desired format.
>
> This patch provides a positive example first in the guide so that it's
> harder to miss, then leaves the existing less desirable approach below
> for contributors to follow if they have some stronger justification for
> why to use that approach.
>
> Signed-off-by: Joe Stringer <joe@isovalent.com>
> ---
> v3: Fix grammar mistake
> v2: Simplify recommendation for either simple or grid table syntax
>     Remove example, link to rST user reference
> ---
>  Documentation/doc-guide/sphinx.rst | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)

I stumbled across this languishing in my docs folder, sorry ... it's
applied now, thanks.

jon

      parent reply	other threads:[~2023-06-09  8:00 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-24 17:18 [PATCH linux-doc v3] docs/doc-guide: Clarify how to write tables Joe Stringer
2023-04-24 20:13 ` Randy Dunlap
2023-06-09  7:58 ` Jonathan Corbet [this message]

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=87mt19oyms.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