Skip to content

Commit

Permalink
encouraged use of darker instead of black
Browse files Browse the repository at this point in the history
  • Loading branch information
orbeckst committed Dec 1, 2023
1 parent 9af161c commit b6421c8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/source/contributing_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -518,9 +518,9 @@ Or if you're ok with the suggested formatting changes, just apply the suggested

.. note::

MDAnalysis does *not* currently use the `black`_ code formatter across the whole project, therefore please consider the following rules:
MDAnalysis does *not* currently use the popular `black`_ code formatter across the whole project, therefore please consider the following rules:

* Do **not run ``black`` on an existing file** that you are editing. This makes the diff for the PR very difficult to read.
* Do **not run ``black`` on an existing file** that you are editing. This makes the diff for the PR very difficult to read. Instead use ``darker`` as explained above to only reformat your changes.
* You *may* run ``black`` on a *new file* that you are adding to the code base.

For an ongoing discussion (which you are welcome to join) see `issue #2450`_.
Expand Down

0 comments on commit b6421c8

Please sign in to comment.