summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code/coding-style.txt
diff options
context:
space:
mode:
authorMike Edmunds <medmunds@gmail.com>2025-07-21 15:06:49 -0700
committernessita <124304+nessita@users.noreply.github.com>2025-07-23 20:17:55 -0300
commit3ad0e759a637077b8b7064e3559cc70490311010 (patch)
tree092d575e8822e982f2d4c07f0e5ac15e7cb9fa3f /docs/internals/contributing/writing-code/coding-style.txt
parent78298b51629e14c0e472898b635bc819d47b7f27 (diff)
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.
Diffstat (limited to 'docs/internals/contributing/writing-code/coding-style.txt')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt10
1 files changed, 4 insertions, 6 deletions
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 <old-string-formatting>`, :py:ref:`f-strings