Skip to content

Commit b6421c8

Browse files
committed
encouraged use of darker instead of black
1 parent 9af161c commit b6421c8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/source/contributing_code.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -518,9 +518,9 @@ Or if you're ok with the suggested formatting changes, just apply the suggested
518518

519519
.. note::
520520

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

523-
* Do **not run ``black`` on an existing file** that you are editing. This makes the diff for the PR very difficult to read.
523+
* 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.
524524
* You *may* run ``black`` on a *new file* that you are adding to the code base.
525525

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

0 commit comments

Comments
 (0)