linux-kernel - Re: [PATCH] doc: flat-table directive

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Fri, 1 Jul 2016 08:35:13 +0200
From:	Markus Heiser <markus.heiser@...marit.de>
To:	Jonathan Corbet <corbet@....net>
Cc:	mchehab@....samsung.com, linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org, jani.nikula@...el.com,
	hverkuil@...all.nl, daniel.vetter@...ll.ch, airlied@...il.com,
	grant.likely@...retlab.ca, rdunlap@...radead.org, keithp@...thp.com
Subject: Re: [PATCH] doc: flat-table directive

Am 30.06.2016 um 21:05 schrieb Jonathan Corbet <corbet@....net>:

> On Thu, 30 Jun 2016 14:00:21 +0200
> Markus Heiser <markus.heiser@...marIT.de> wrote:
> 
>> this is my flat-table patch on top of your docs-next branch / we discussed on
>> the ML
> 
> Hmm...  we don't have an official kernel coding style for Python, but if
> we did, I'd sure like it to be a lot more like the usual Python
> conventions.

Please help me, what in the patch is not usual Python? 

There is a "Style Guide for Python Code" PEP 8 [1] from which
I (hopefully) differ only in marginal details. I use the 
pylint [3] which checks PEP8 style, may I switched of to much?
E.g. the "one-liner classes" of mine is not PEP8 style, is this what
you mean? Or is it about the (comma) operators in front of
a new line [2]? Could you give me more detail hints / thanks.

[1] https://www.python.org/dev/peps/pep-0008/
[2] https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator
[3] https://www.pylint.org/

> The added documentation describes the "widths" parameter, but does not
> tell the reader which units are used.

It has no units, it's relativ. Sorry, I implied that it is a common practice
on table layouts [4]:

  """A comma- or space-separated list of relative column widths. 
     The default is equal-width columns (100%/#columns)."""

[4] http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table 

> There were also a lot of typos and misspellings in the documentation
> addition.

Sorry, I did it in a hurry because Mauro needs it promptly. I will improve 
myself in the future.

> Anyway, I don't want to delay this work, so I have gone ahead and applied
> it; I fixed the spelling errors on the way.

Thanks a lot!

>  When you get a chance, can I
> get a doc tweak for :widths:?

Yes, I will send you a patch later.

-- Markus --

> Thanks for separating this work out,
> 
> jon