summaryrefslogtreecommitdiff
path: root/docs/source/release-notes
diff options
context:
space:
mode:
authorIan Stapleton Cordasco <graffatcolmingov@gmail.com>2021-10-10 19:08:29 -0500
committerIan Stapleton Cordasco <graffatcolmingov@gmail.com>2021-10-10 19:18:51 -0500
commit807904aebc20814ac595b0004ab526fffb5ef681 (patch)
tree14c10b9f867c0f955a2722bee6e24b71690ae27d /docs/source/release-notes
parent0b1c790443a9777c5d945f963e22571698fadf8c (diff)
downloadflake8-807904aebc20814ac595b0004ab526fffb5ef681.tar.gz
Drop support for Home and XDG config files
This has been a huge support burden for us. I seriously considered doing this in 3.0 but caved to a vocal minority and the desire to keep as much backwards compatibility as possible. At this point, however, I'm done witnessing the abuse Anthony has to suffer over this and I'm done with the undue hostility that people who don't bother to read the docs display. Hopefully, this eases that a bit.
Diffstat (limited to 'docs/source/release-notes')
-rw-r--r--docs/source/release-notes/4.0.0.rst16
-rw-r--r--docs/source/release-notes/index.rst6
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/source/release-notes/4.0.0.rst b/docs/source/release-notes/4.0.0.rst
new file mode 100644
index 0000000..e997d09
--- /dev/null
+++ b/docs/source/release-notes/4.0.0.rst
@@ -0,0 +1,16 @@
+4.0.0 -- 202x-mm-dd
+-------------------
+
+You can view the `4.0.0 milestone`_ on GitHub for more details.
+
+Backwards Incompatible Changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Due to constant confusion by users, user-level |Flake8| configuration files
+ are no longer supported. Files will not be searched for in the user's home
+ directory (e.g., ``~/.flake8``) nor in the XDG config directory (e.g.,
+ ``~/.config/flake8``).
+
+.. all links
+.. _4.0.0 milestone:
+ https://github.com/PyCQA/flake8/milestone/39
diff --git a/docs/source/release-notes/index.rst b/docs/source/release-notes/index.rst
index dd20253..3617ff4 100644
--- a/docs/source/release-notes/index.rst
+++ b/docs/source/release-notes/index.rst
@@ -5,6 +5,12 @@
All of the release notes that have been recorded for Flake8 are organized here
with the newest releases first.
+4.x Release Series
+==================
+
+.. toctree::
+ 4.0.0
+
3.x Release Series
==================