File tree Expand file tree Collapse file tree 2 files changed +23
-1
lines changed
api/next_api_changes/development Expand file tree Collapse file tree 2 files changed +23
-1
lines changed Original file line number Diff line number Diff line change 1+ Maximum line length increased to 88 characters
2+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+ The maximum line length for new contributions has been extended from 79 characters to
5+ 88 characters.
6+ This change provides an extra 9 characters to allow code which is a single idea to fit
7+ on fewer lines (often a single line).
8+ Other line lengths considered included 115 and 99, but ultimately 88 characters was the
9+ consensus as it is relatively conservative while still providing reasonable benefit.
10+ The ability to view side-by-side git diffs was a key point in choosing the smaller
11+ limit.
12+ Additionally, it is easier to increase the line length again than to decrease it if it
13+ was found too large.
14+ The chosen length is the same as `black <https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length >`_.
15+ Their justifications influenced the discussion and provided a standard value.
Original file line number Diff line number Diff line change @@ -30,7 +30,8 @@ rules before submitting a pull request:
3030 for more details.
3131
3232* Formatting should follow the recommendations of PEP8 _, as enforced by
33- flake8 _. You can check flake8 compliance from the command line with ::
33+ flake8 _. Matplotlib modifies PEP8 to extend the maximum line length to 88
34+ characters. You can check flake8 compliance from the command line with ::
3435
3536 python -m pip install flake8
3637 flake8 /path/to/module.py
@@ -156,6 +157,12 @@ Content topics:
156157* Does the PR conform with the :ref: `coding_guidelines `?
157158* Is the :ref: `documentation <pr-documentation >` (docstrings, examples,
158159 what's new, API changes) updated?
160+ * Is the change only reflowing code/docstrings for increased line length?
161+ Generally, such changes are discouraged when not part of other non-stylistic
162+ work because it obscures the git history of functional changes to the code.
163+ Reflowing a method or docstring as part of a larger refactor/rewrite is
164+ acceptable.
165+
159166
160167Organizational topics:
161168
You can’t perform that action at this time.
0 commit comments