X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8c3c190f9978d08b8b6e505112a019a20cc9e6fc..8d036ceb3f0a0e0b52276e8d4afe840d1fcad11b:/docs/compatible_configs.md?ds=sidebyside diff --git a/docs/compatible_configs.md b/docs/compatible_configs.md index b182f57..aa7cd96 100644 --- a/docs/compatible_configs.md +++ b/docs/compatible_configs.md @@ -6,6 +6,10 @@ linters and type checkers. Some of them need a bit of tweaking to resolve the co Listed below are _Black_ compatible configurations in various formats for the common tools out there. +**Please note** that _Black_ only supports the TOML file format for its configuration +(e.g. `pyproject.toml`). The provided examples are to only configure their corresponding +tools, using **their** supported file formats. + ## isort [isort](https://pypi.org/p/isort/) helps to sort and format imports in your Python code. @@ -25,7 +29,7 @@ line_length = 88 ### Why those options above? _Black_ wraps imports that surpass `line-length` by moving identifiers into their own -indented line. If that still doesn't fit the bill, it will put all of them in seperate +indented line. If that still doesn't fit the bill, it will put all of them in separate lines and put a trailing comma. A more detailed explanation of this behaviour can be [found here](https://github.com/psf/black#how-black-wraps-lines). @@ -96,9 +100,9 @@ line_length = 88 ```toml [tool.isort] multi_line_output = 3 -include_trailing_comma = True +include_trailing_comma = true force_grid_wrap = 0 -use_parentheses = True +use_parentheses = true line_length = 88 ```