docs/doc-guide: Clarify how to write tables
authorJoe Stringer <joe@isovalent.com>
Mon, 24 Apr 2023 17:18:50 +0000 (10:18 -0700)
committerJonathan Corbet <corbet@lwn.net>
Fri, 9 Jun 2023 07:57:56 +0000 (01:57 -0600)
commit35d4a3c67eb5fe786e93e06df103fc3f181eaf07
treeb41925071916f9a8e29c627da9fe7f92296671b7
parenteed892da9cd08be76a8f467c600ef58716dbb4d2
docs/doc-guide: Clarify how to write tables

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>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230424171850.3612317-1-joe@isovalent.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/doc-guide/sphinx.rst