Doc for linter version specifiers, amend changelog

akaihola · Mar 30, 2022 · 23b703a · 23b703a
1 parent 61f03f6
commit 23b703a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -7,7 +7,7 @@ Added
 -----
 - The ``--jobs`` option now specifies how many Darker jobs are used to process files in
   parallel to complete reformatting/linting faster.
-- Linters can now be run in the GitHub Action using the ``lint:`` option.
+- Linters can now be installed and run in the GitHub Action using the ``lint:`` option.
 
 Fixed
 -----

diff --git a/README.rst b/README.rst
@@ -575,7 +575,7 @@ Create a file named ``.github/workflows/darker.yml`` inside your repository with
              revision: "master..."
              src: "./src"
              version: "1.4.2"
-             lint: "flake8,pylint"
+             lint: "flake8,pylint==2.13.1"
 
 There needs to be a working Python environment, set up using ``actions/setup-python``
 in the above example. Darker will be installed in an isolated virtualenv to prevent
@@ -603,6 +603,7 @@ You can e.g. add ``"--isort"`` to sort imports, or ``"--verbose"`` for debug log
 
 To run linters through Darker, you can provide a comma separated list of linters using
 the ``lint:`` option. Only ``flake8``, ``pylint`` and ``mypy`` are supported.
+Versions can be constrained using ``pip`` syntax, e.g. ``"flake8>=3.9.2"``.
 
 *New in version 1.1.0:*
 GitHub Actions integration. Modeled after how Black_ does it,