From 209de2db1f62a672d2190e47a80612895380cdbc Mon Sep 17 00:00:00 2001 From: Dimitri Papadopoulos Orfanos <3234522+DimitriPapadopoulos@users.noreply.github.com> Date: Sat, 15 Jun 2024 01:46:01 +0200 Subject: [PATCH] The source is auto-formatted with ruff, not black (#798) I had forgotten to change that in cb8fd38. Co-authored-by: Brett Cannon --- docs/development/submitting-patches.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/development/submitting-patches.rst b/docs/development/submitting-patches.rst index d05637a6..79536458 100644 --- a/docs/development/submitting-patches.rst +++ b/docs/development/submitting-patches.rst @@ -18,7 +18,7 @@ follow the directions on the :doc:`security page `. Code ---- -This project's source is auto-formatted with |black|. You can check if your +This project's source is auto-formatted with |ruff|. You can check if your code meets our requirements by running our linters against it with ``nox -s lint`` or ``pre-commit run --all-files``. @@ -67,8 +67,8 @@ So, specifically: * Use Sphinx parameter/attribute documentation `syntax`_. -.. |black| replace:: ``black`` -.. _black: https://pypi.org/project/black/ +.. |ruff| replace:: ``ruff`` +.. _ruff: https://astral.sh/ruff .. _`Write comments as complete sentences.`: https://nedbatchelder.com/blog/201401/comments_should_be_sentences.html .. _`syntax`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html .. _`Studies have shown`: https://www.microsoft.com/en-us/research/publication/characteristics-of-useful-code-reviews-an-empirical-study-at-microsoft/