Skip to content

Commit 064c1bf

Browse files
committed
Doc for linter version specifiers, amend changelog
1 parent 61f03f6 commit 064c1bf

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

CHANGES.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Added
77
-----
88
- The ``--jobs`` option now specifies how many Darker jobs are used to process files in
99
parallel to complete reformatting/linting faster.
10-
- Linters can now be run in the GitHub Action using the ``lint:`` option.
10+
- Linters can now be installed and run in the GitHub Action using the ``lint:`` option.
1111

1212
Fixed
1313
-----

README.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -575,7 +575,7 @@ Create a file named ``.github/workflows/darker.yml`` inside your repository with
575575
revision: "master..."
576576
src: "./src"
577577
version: "1.4.2"
578-
lint: "flake8,pylint"
578+
lint: "flake8,pylint==2.13.1"
579579
580580
There needs to be a working Python environment, set up using ``actions/setup-python``
581581
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
603603

604604
To run linters through Darker, you can provide a comma separated list of linters using
605605
the ``lint:`` option. Only ``flake8``, ``pylint`` and ``mypy`` are supported.
606+
Versions can be constrained using ``pip`` syntax, e.g. ``"flake8>=3.9.2"``.
606607

607608
*New in version 1.1.0:*
608609
GitHub Actions integration. Modeled after how Black_ does it,

action.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ inputs:
2525
lint:
2626
description: >-
2727
Comma-separated list of linters to `pip install` and run from Darker.
28-
Optionally, version constraints (using pip syntax) can be specifed.
28+
Optionally, version constraints (using pip syntax) can be specified.
2929
Example: flake8,pylint==2.13.1
3030
required: false
3131
default: ''

0 commit comments

Comments
 (0)