Skip to content
Snippets Groups Projects
Commit 35d4a3c6 authored by Joe Stringer's avatar Joe Stringer Committed by Jonathan Corbet
Browse files

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: default avatarJoe Stringer <joe@isovalent.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230424171850.3612317-1-joe@isovalent.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent eed892da
No related branches found
No related tags found
No related merge requests found
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment