From 79b6472c7c7be4fbcaa511fdd769e27a435c3d8b Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Mon, 5 Sep 2022 12:27:39 -0400 Subject: [PATCH] Add a note RE Black compat --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 85b702165a..7846eb699e 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,14 @@ OPTIONS: -w, --watch Run in watch mode by re-running whenever files change ``` +### Compatibility with Black + +ruff is intended to be compatible with [Black](https://github.com/psf/black), and should be +compatible out-of-the-box as long as the `line-length` setting is consistent between the two. + +As a project, ruff is designed to be used alongside Black and, as such, will defer implementing +lint rules that are obviated by Black (e.g., stylistic rules). + ## Rules | Code | Name | Message |