Re: [PATCH 1/2] ext4: docs: switch away from list-table
From: Akira Yokosawa <akiyks@gmail.com>
Date: 2021-09-03 06:34:17
Also in:
linux-doc
From: Akira Yokosawa <akiyks@gmail.com>
Date: 2021-09-03 06:34:17
Also in:
linux-doc
Hi Jon, On Thu, 2 Sep 2021 16:08:53 -0600, Jonathan Corbet wrote:
Commit 3a6541e97c03 (Add documentation about the orphan file feature) added a new document on orphan files, which is great. But the use of "list-table" results in documents that are absolutely unreadable in their plain-text form. Switch this file to the regular RST table format instead; the rendered (HTML) output is identical.
In the "list tables" section of doc-guide/sphinx.rst, the first paragraph
starts with the sentence:
We recommend the use of list table formats.
Yes, the disadvantage of list tables is mentioned later in the paragraph:
Compared to the ASCII-art they might not be as comfortable for readers
of the text files.
, but I still see list-table is meant as the preferred format.
If you prefer the ASCII-art form for simple tables, you might need to
de-emphasize the above mentioned recommendation as well.
Thanks, Akira