From 3ad0e759a637077b8b7064e3559cc70490311010 Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Mon, 21 Jul 2025 15:06:49 -0700 Subject: [PATCH] Fixed #36500 -- Set flake8 max-doc-length config to 79 columns. Set flake8 max-doc-length to 79 to enforce smaller line length limit on docstrings and comments (per coding-style docs). Updated docs to clarify both requirements are enforced by flake8 and to remove some leftover language from the pre-black era. --- .flake8 | 1 + .../contributing/writing-code/coding-style.txt | 10 ++++------ 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.flake8 b/.flake8 index c4094af462..bd5e70e828 100644 --- a/.flake8 +++ b/.flake8 @@ -2,6 +2,7 @@ exclude = build,.git,.tox,./tests/.env extend-ignore = E203 max-line-length = 88 +max-doc-length = 79 per-file-ignores = django/core/cache/backends/filebased.py:W601 django/core/cache/backends/base.py:W601 diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index c7502985b6..656ce0abd5 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -52,12 +52,10 @@ Python style that :pep:`8` is only a guide, so respect the style of the surrounding code as a primary goal. - An exception to :pep:`8` is our rules on line lengths. Don't limit lines of - code to 79 characters if it means the code looks significantly uglier or is - harder to read. We allow up to 88 characters as this is the line length used - by ``black``. This check is included when you run ``flake8``. Documentation, - comments, and docstrings should be wrapped at 79 characters, even though - :pep:`8` suggests 72. + An exception to :pep:`8` is our rules on line lengths. We allow up to 88 + characters in code, as this is the line length used by ``black``. + Documentation, comments, and docstrings should be wrapped at 79 characters. + These limits are checked when ``flake8`` is run. * String variable interpolation may use :py:ref:`%-formatting `, :py:ref:`f-strings