From fbdb331772613dfdb70ade40509c3f8dcb70fd57 Mon Sep 17 00:00:00 2001
From: YuviPanda <yuvipanda@gmail.com>
Date: Mon, 30 Dec 2024 13:35:58 -0800
Subject: [PATCH] Describe *why* isort is configured, not what it is

In general I think comments should describe 'why' rather than
'what', or they end up being mostly noise.
---
 pyproject.toml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 897aacfe8..dd14d04e3 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -14,7 +14,10 @@ build-backend = "setuptools.build_meta"
 target-version = ["py38", "py39", "py310", "py311"]
 
 
-# isort is used for autoformatting Python code
+# The default isort output conflicts with black autoformatting.
+# Tell isort to behave nicely with black
+# See https://pycqa.github.io/isort/docs/configuration/black_compatibility.html
+# for more information.
 [tool.isort]
 profile = "black"