Skip to content

Commit 4e7e28b

Browse files
committed
CODING_CONVENTIONS.md: improve spelling in Python section
Minor formatting and spelling corrections in the Python coding convention section.
1 parent de5cef0 commit 4e7e28b

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CODING_CONVENTIONS.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -452,17 +452,18 @@ not a string literal`.
452452

453453
## Python coding convention
454454

455-
* Code shall be compliant with Python 3.10 minimum because this is the default
456-
Python 3 version in Ubuntu 22.04 (used as the reference system for CI)
455+
* Code shall be compliant with Python 3.10 at minimum, because this is the
456+
default Python 3 version in Ubuntu 22.04 (used as the reference system for
457+
CI).
457458
* Code shall report no error when running the
458459
[Flake8](http://flake8.pycqa.org/en/latest/) tool, e.g:
459460
* for style checks described in
460-
[PEP8](https://www.python.org/dev/peps/pep-0008/),
461+
[PEP 8](https://www.python.org/dev/peps/pep-0008/),
461462
* for lint checks provided by
462463
[Pyflakes](https://pypi.python.org/pypi/pyflakes),
463464
* for complexity checks provided by the
464465
[McCabe project](https://pypi.python.org/pypi/mccabe)
465-
* A line length of maximum of 120 is allowed instead of the pep8 79: this
466+
* A line length of maximum of 120 is allowed instead of 79 as per PEP 8. This
466467
increases tests readability as they can expects long line of output.
467468
* Only runnable scripts shall start with `#!/usr/bin/env python3`
468469
* Runnable scripts shall use the following scheme:

0 commit comments

Comments
 (0)