Skip to content

Commit

Permalink
Update code style config files to avoid
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Sep 30, 2020
1 parent 100337f commit 062e2ed
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/python/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Style guide

All code is checked as documented by `standard-maintenance-scripts <https://github.com/open-contracting/standard-maintenance-scripts#tests>`__.

Repositories should not use ``.flake8`` or ``setup.cfg`` files to configure the behavior of ``flake8`` or ``isort``, except to ignore generated files like database migrations. Maintainers can find configuration files with:
Repositories should not use ``setup.cfg``, ``.flake8``, ``.isort.cfg``, ``.editorconfig`` or ``pyproject.toml`` files to configure the behavior of ``flake8`` or ``isort``, except to ignore generated files like database migrations. Maintainers can find configuration files with:

.. code-block:: bash
find . \( -name 'setup.cfg' -or -name '.flake8' \) -exec echo {} \; -exec cat {} \;
find . \( -name 'setup.cfg' -or -name '.flake8' -or -name '.isort.cfg' -or -name '.editorconfig' -or -name 'pyproject.toml' \) -exec echo {} \; -exec cat {} \;
``noqa`` comments should be kept to a minimum, and should reference the specific error, to avoid shadowing another error: for example, ``# noqa: E501``.

Expand Down

0 comments on commit 062e2ed

Please sign in to comment.