docs: add a note to remember why flake8 configuration is repeated

diff --git a/.flake8 b/.flake8
index d2473a1ae417a99c6d018cb6508ddabf37c63317..35bb95d7caa46704b4dbbca8612567f87f379682 100644 (file)
--- a/.flake8
+++ b/.flake8
@@ -1,3 +1,8 @@
+# Note: configuration is repeated in the package directories because flake8
+# will find the setup.cfg there and will not use this file.
+# We also need a copy here because running flake8 from the root dir will
+# use no configuration file otherwise. So, apologise for the repetitions.
+
 [flake8]
 max-line-length = 88
 ignore = W503, E203, E704