Re: [DOCS] Python Language Conventions

["Martin Liška" <mliska@suse.cz>]

On 10/13/22 19:16, David Malcolm wrote:
> On Thu, 2022-10-13 at 11:44 +0200, Gerald Pfeifer wrote:
>> Hi Martin,
>>
>> On Thu, 13 Oct 2022, Martin Liška wrote:
>>> I think we should add how Python scripts should be formatted. I
>>> noticed
>>> that while reading the Modula-2 patchset where it follows the C/C++
>>> style
>>> when it comes to Python files.
>>
>> good initiative, thank you! This makes sense to me, alas I'm not a
>> Python 
>> hacker, so best wait to see what David and Gaius think, too?
> 
> I'm very much +1 on recommending PEP 8.
> 
> My Python skills are bit-rotting somewhat, and I've not used flake8,
> but it seems a reasonable recommendation to me.

All right, let me install my initial patch with the improved wording.

Cheers,
Martin

> 
>>
>>
>> Some suggestions on the web side of things:
>>
>>> +<li><a href="#Python_Conventions">Python Language Conventions</a>
>>
>> Since the name of the page already is codingconventions.html, I
>> suggest
>> making this simply "#python" - shorter and simpler. :-)
>>
>>> +Python scripts should follow <a
>>> href="https://peps.python.org/pep-0008/">PEP 8 – Style Guide for
>>> Python Code</a>
>>> +which can be verified by <a href="flake8.pycqa.org">flake8</a>
>>> tool.
>>
>> ...by the...tool.
>>
>>> +We do also recommend using the following <code>flake8</code> plug-
>>> ins:
>>
>> Here maybe simply say "We recommend using"?
> 
> That's a much better wording.
> 
> Dave
> 
>>
>> Hope this helps,
>> Gerald
>