From 4e7e28bb07b00cf62cba72372202023418ac2ac0 Mon Sep 17 00:00:00 2001 From: Bas Stottelaar Date: Fri, 10 Jan 2025 07:33:18 +0100 Subject: [PATCH] CODING_CONVENTIONS.md: improve spelling in Python section Minor formatting and spelling corrections in the Python coding convention section. --- CODING_CONVENTIONS.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CODING_CONVENTIONS.md b/CODING_CONVENTIONS.md index f274476e27e7..d6d58b4a5d7a 100644 --- a/CODING_CONVENTIONS.md +++ b/CODING_CONVENTIONS.md @@ -452,17 +452,18 @@ not a string literal`. ## Python coding convention -* Code shall be compliant with Python 3.10 minimum because this is the default - Python 3 version in Ubuntu 22.04 (used as the reference system for CI) +* Code shall be compliant with Python 3.10 at minimum, because this is the + default Python 3 version in Ubuntu 22.04 (used as the reference system for + CI). * Code shall report no error when running the [Flake8](http://flake8.pycqa.org/en/latest/) tool, e.g: * for style checks described in - [PEP8](https://www.python.org/dev/peps/pep-0008/), + [PEP 8](https://www.python.org/dev/peps/pep-0008/), * for lint checks provided by [Pyflakes](https://pypi.python.org/pypi/pyflakes), * for complexity checks provided by the [McCabe project](https://pypi.python.org/pypi/mccabe) -* A line length of maximum of 120 is allowed instead of the pep8 79: this +* A line length of maximum of 120 is allowed instead of 79 as per PEP 8. This increases tests readability as they can expects long line of output. * Only runnable scripts shall start with `#!/usr/bin/env python3` * Runnable scripts shall use the following scheme: