From 8a93ce8ccef8af2411f9cdbf5b65c6e9aa7486fe Mon Sep 17 00:00:00 2001 From: Serene-Arc <33189705+Serene-Arc@users.noreply.github.com> Date: Sun, 24 Sep 2023 14:03:35 +1000 Subject: [PATCH] Add instruction to format with tox --- CONTRIBUTING.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bf2537e4f..d91966011 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -219,6 +219,8 @@ Style We follow `black`_ formatting and `google's docstring format`_. You can use ``tox -e lint`` to check your code for any style errors. +Running ``tox -e format`` will automatically format your code according +to the specifications required by the project. .. _black: https://black.readthedocs.io/en/stable/ .. _google's docstring format: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings