X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8126b4f6a9342290de4655e6a8a78cd288ce7daa..a9047710932a509f9ba24dde0160e8ae3afc218f:/README.md diff --git a/README.md b/README.md index 4d7f5fd..43d47fc 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,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 +658,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: @@ -985,6 +998,8 @@ code style: pytest, tox, Pyramid, Django Channels, Hypothesis, attrs, SQLAlchemy Poetry, PyPA applications (Warehouse, Pipenv, virtualenv), pandas, Pillow, every Datadog Agent Integration, Home Assistant. +The following organizations use _Black_: Dropbox. + Are we missing anyone? Let us know. ## Testimonials