From cabeb5b5457b8fd29d608eca944be6074bd3f31f Mon Sep 17 00:00:00 2001 From: Bibo-Joshi Date: Tue, 27 Oct 2020 21:59:43 +0100 Subject: [PATCH] Document some culprits with pre-commit (#1783) * Document some culprits with pre-commit * make pre-commit happy * don't use monospace for black & pre-commit Co-authored-by: Hugo van Kemenade * make pre-commit happy again Co-authored-by: Hugo van Kemenade --- docs/version_control_integration.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/version_control_integration.md b/docs/version_control_integration.md index 2d8bc17..0e09854 100644 --- a/docs/version_control_integration.md +++ b/docs/version_control_integration.md @@ -23,6 +23,11 @@ for your project. See _Black_'s own [pyproject.toml](https://github.com/psf/black/blob/master/pyproject.toml) for an example. +When using the `--diff` flag with `pre-commit`, you must also use the `--check` flag. +When you want to run _Black_ only on specific files in pre-commit, either use +pre-commit's own `files` and `exclude` or, when using _Black_'s `--include`, set +`--force-exclude` to the negated regex of `--include`. + If you're already using Python 3.7, switch the `language_version` accordingly. Finally, `stable` is a branch that tracks the latest release on PyPI. If you'd rather run on master, this is also an option. -- 2.39.5