docs: discourage use of list tables
Jonathan Corbet
maintainerPATCH 1/1 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.
--- Documentation/doc-guide/sphinx.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-)
Documentation/doc-guide/sphinx.rst +5 -6
@@ -261,12 +261,11 @@ please feel free to remove it. list tables ----------- -We recommend the use of *list table* formats. The *list table* formats are -double-stage lists. Compared to the ASCII-art they might not be as -comfortable for -readers of the text files. Their advantage is that they are easy to -create or modify and that the diff of a modification is much more meaningful, -because it is limited to the modified content. +The list-table formats can be useful for tables that are not easily laid +out in the usual Sphinx ASCII-art formats. These formats are nearly +impossible for readers of the plain-text documents to understand, though, +and should be avoided in the absence of a strong justification for their +use. The ``flat-table`` is a double-stage list similar to the ``list-table`` with some additional features:
Signature · 1 line
2.33.1
Quoted 6 lines · Jonathan Corbet
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.
Signed-off-by Jonathan Corbet <[email protected]>
for sure.
Thanks.
Quoted 26 lines
--- Documentation/doc-guide/sphinx.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-)Documentation/doc-guide/sphinx.rst +5
-6@@ -261,12 +261,11 @@ please feel free to remove it. list tables ----------- -We recommend the use of *list table* formats. The *list table* formats are -double-stage lists. Compared to the ASCII-art they might not be as -comfortable for -readers of the text files. Their advantage is that they are easy to -create or modify and that the diff of a modification is much more meaningful, -because it is limited to the modified content. +The list-table formats can be useful for tables that are not easily laid +out in the usual Sphinx ASCII-art formats. These formats are nearly +impossible for readers of the plain-text documents to understand, though, +and should be avoided in the absence of a strong justification for their +use. The ``flat-table`` is a double-stage list similar to the ``list-table`` with some additional features:
Signature · 1 line
~Randy
Quoted 4 lines · Jonathan Corbet
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.
Thanks!