Skip to content

Commit

Permalink
CODING_CONVENTIONS.md: improve spelling in Python section
Browse files Browse the repository at this point in the history
Minor formatting and spelling corrections in the Python coding
convention section.
  • Loading branch information
basilfx committed Jan 10, 2025
1 parent de5cef0 commit 4e7e28b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CODING_CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 4e7e28b

Please sign in to comment.