Skip to content

Commit

Permalink
Clarify linter configuration in --help
Browse files Browse the repository at this point in the history
  • Loading branch information
akaihola committed Jan 15, 2023
1 parent 3255c63 commit d31d8a8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -332,10 +332,11 @@ The following `command line arguments`_ can also be used to modify the defaults:
-i, --isort
Also sort imports using the ``isort`` package
-L CMD, --lint CMD
Also run a linter on changed files. ``CMD`` can be a name of path of the linter
binary, or a full quoted command line. Highlight linter output syntax if on a
terminal and the ``pygments`` package is available, or if enabled by
configuration.
Also run a linter on changed files. ``CMD`` can be a name or path of the linter
binary, or a full quoted command line with the command and options. Linters read
their configuration as normally, and aren't affected by -c / --config. Linter
output is syntax highlighted when the ``pygments`` package is available if run on
a terminal and or enabled by explicitly (see --color).
-c PATH, --config PATH
Ask ``black`` and ``isort`` to read configuration from ``PATH``. Note that other
tools like flynt, Mypy, Pylint and Flake8 won't use this configuration file.
Expand Down
9 changes: 5 additions & 4 deletions src/darker/help.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,11 @@
ISORT = "".join(ISORT_PARTS)

LINT = (
"Also run a linter on changed files. `CMD` can be a name of path of the"
" linter binary, or a full quoted command line. Highlight linter output syntax if"
" on a terminal and the `pygments` package is available, or if enabled by"
" configuration."
"Also run a linter on changed files. `CMD` can be a name or path of the linter"
" binary, or a full quoted command line with the command and options. Linters read"
" their configuration as normally, and aren't affected by -c / --config. Linter"
" output is syntax highlighted when the `pygments` package is available if run on"
" a terminal and or enabled by explicitly (see --color)."
)

CONFIG = (
Expand Down

0 comments on commit d31d8a8

Please sign in to comment.