lkml.org 
[lkml]   [2019]   [Jan]   [2]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 2/2] doc: cgroup: highlight all paths using the :file: inline markup
On Wed, 2 Jan 2019 08:01:49 -0800
Tejun Heo <tj@kernel.org> wrote:

> On Sun, Dec 30, 2018 at 05:50:44PM +0100, Otto Sabart wrote:
> > Improve readability using the :file: markup.
>
> Heh, that's a minor plus for formatted output and minor minus for the
> source. If this is a convention generally followed for
> documentations, I have no objects. That said, can you please reflow
> the lines?

The convention is to minimize markup, especially in cases where it's not
really needed and it impairs the readability of the plain-text file. My
feeling is that this particular markup doesn't provide enough benefit to
be worth the cost.

Otto, we all very much appreciate attempts to improve the documentation,
and I hope you won't stop. If you would like to do RST work, one very
helpful thing would be to look into the conversion of the (many) remaining
plain-text documents and integration into the doc tree.

Thanks,

jon

\
 
 \ /
  Last update: 2019-01-02 17:10    [W:0.064 / U:68.352 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site