X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/4041c560ec8e0233b448d97595fc9b7018a25c32..8e38b6626be681adbb367820ce65e05254664629:/README.md diff --git a/README.md b/README.md index 3b5e607..def311f 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,6 @@ Options: Python versions that should be supported by Black's output. [default: per-file auto- detection] - --py36 Allow using Python 3.6-only syntax on all - input files. This will put trailing commas - in function signatures and calls also after - *args and **kwargs. Deprecated; use - --target-version instead. [default: per-file - auto-detection] --pyi Format all input files like typing stubs regardless of file extension (useful when piping source on standard input). @@ -127,6 +121,16 @@ _Black_ is a well-behaved Unix-style command-line tool: - it only outputs messages to users on standard error; - exits with code 0 unless an internal error occurred (or `--check` was used). +### Using _Black_ with other tools + +While _Black_ enforces formatting that conforms to PEP 8, other tools may raise warnings +about _Black_'s changes or will overwrite _Black_'s changes. A good example of this is +[isort](https://pypi.org/p/isort). Since _Black_ is barely configurable, these tools +should be configured to neither warn about nor overwrite _Black_'s changes. + +Actual details on _Black_ compatible configurations for various tools can be found in +[compatible_configs](./docs/compatible_configs.md). + ### NOTE: This is a beta product _Black_ is already [successfully used](#used-by) by many projects, small and big. It @@ -648,6 +652,9 @@ $ where black %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location ``` +Note that if you are using a virtual environment detected by PyCharm, this is an +unneeded step. In this case the path to `black` is `$PyInterpreterDirectory$/black`. + 3. Open External tools in PyCharm/IntelliJ IDEA On macOS: