Update wording in Code Quality doc [build docs]

tardis-sn · Jul 13, 2021 · bbbd5ec · bbbd5ec
1 parent 9780457
commit bbbd5ec
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/development/code_quality.rst b/docs/development/code_quality.rst
@@ -24,7 +24,7 @@ Black
 
 A better method is to run Black automatically - first `integrate it within the code editor <https://black.readthedocs.io/en/stable/editor_integration.html>`_ you use and then enable the "format on save" or "format on type" option in your editor settings.
 
-If you've installed pre-commit hooks (`pre-commit install`) Black will run before each commit.
+Alternatively, Black will run automatically before each commit if you've installed pre-commit hooks (as mentioned in :ref:`Git worklfow <pre-commit-install>`).
 
 .. warning :: If your code doesn't follow the Black code style, then the Black-check action on your PR will fail.
 

diff --git a/docs/development/git_workflow.rst b/docs/development/git_workflow.rst
@@ -151,6 +151,8 @@ TARDIS repository clone.
    repository will always be immediately available next time you start a Python
    interpreter and ``import tardis``.
 
+.. _pre-commit-install:
+
 #. Install pre-commit hooks::
 
        $ pre-commit install --install-hooks