From b6421c8c76ce6191efbc777d5f39113589882bfb Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Fri, 1 Dec 2023 13:17:27 -0700 Subject: [PATCH] encouraged use of darker instead of black --- doc/source/contributing_code.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/contributing_code.rst b/doc/source/contributing_code.rst index 5fdde3d45..05ece7f2f 100644 --- a/doc/source/contributing_code.rst +++ b/doc/source/contributing_code.rst @@ -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`_.