docs: Improve pre-commit use (#1551)

[etc/vim.git] / docs / compatible_configs.md

diff --git a/docs/compatible_configs.md b/docs/compatible_configs.md
index b182f57a9f3ca026acd76385b3051aabc0b0eff4..aa7cd96f16517d36468ae99fbfaf1d424ed10c65 100644 (file)
--- 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.
 
 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.
 ## 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
 ### 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).
 
 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
 ```toml
 [tool.isort]
 multi_line_output = 3

-include_trailing_comma = True
+include_trailing_comma = true

 force_grid_wrap = 0
 force_grid_wrap = 0

-use_parentheses = True
+use_parentheses = true

 line_length = 88
 ```
 
 line_length = 88
 ```