Skip to content

Commit db67eb7

Browse files
author
Jonathan Corbet
committed
docs: discourage use of list tables
Our documentation encourages the use of list-table formats, but that advice runs counter to the objective of keeping the plain-text documentation as useful and readable as possible. Turn that advice around the other way so that people don't keep adding these tables. Acked-by: Christoph Hellwig <[email protected]> Acked-by: Randy Dunlap <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent bf33a9d commit db67eb7

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

Documentation/doc-guide/sphinx.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,11 @@ please feel free to remove it.
261261
list tables
262262
-----------
263263

264-
We recommend the use of *list table* formats. The *list table* formats are
265-
double-stage lists. Compared to the ASCII-art they might not be as
266-
comfortable for
267-
readers of the text files. Their advantage is that they are easy to
268-
create or modify and that the diff of a modification is much more meaningful,
269-
because it is limited to the modified content.
264+
The list-table formats can be useful for tables that are not easily laid
265+
out in the usual Sphinx ASCII-art formats. These formats are nearly
266+
impossible for readers of the plain-text documents to understand, though,
267+
and should be avoided in the absence of a strong justification for their
268+
use.
270269

271270
The ``flat-table`` is a double-stage list similar to the ``list-table`` with
272271
some additional features:

0 commit comments

Comments
 (0)