Modify project:format to format:check

Author: ArBridgeman

.github/workflows/checks.yml

@@ -158,7 +158,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Run format check
-        run: poetry run -- nox -s project:format
+        run: poetry run -- nox -s format:check
 
   Build-Packages:
     name: Build Package Check

doc/changes/unreleased.md

@@ -2,4 +2,4 @@
 
 ## Refactoring
 
-* #606: Renamed nox session `project:fix` more aptly to `format:fix`
+* #606: Renamed nox session `project:fix` more aptly to `format:fix` and `project:format` to `format:check`

doc/user_guide/features/formatting_code/index.rst

@@ -40,7 +40,7 @@ deterministic manner.
 +====================+==================+====================================+
 | ``format:fix``     | No               | Applies code formatting changes    |
 +--------------------+------------------+------------------------------------+
-| ``project:format`` | ``checks.yml``   | Checks that current code does not  |
+| ``format:check`` | ``checks.yml``   | Checks that current code does not  |
 |                    |                  | need to be re-formatted            |
 +--------------------+------------------+------------------------------------+
 

doc/user_guide/features/formatting_code/troubleshooting.rst

@@ -9,9 +9,9 @@ Formatting still fails after running ``format:fix``
 If when you execute:
 
 #. Run ``format:fix``
-#. Run ``project:format``
+#. Run ``format:check``
 
-you receive an error from ``project:format`` (i.e. ``isort`` or ``black``), it it
+you receive an error from ``format:check`` (i.e. ``isort`` or ``black``), it it
 likely that you need to update your configuration to align with
 :ref:`formatting_configuration`.
 
@@ -44,7 +44,7 @@ might want to ignore automatically applied formatting.
 +-----------------------+--------------------------------+-----------------------+
 
 
-In the ``checks.yml``, ``project:format`` wants me to reformat code I did not modify
+In the ``checks.yml``, ``format:check`` wants me to reformat code I did not modify
 ------------------------------------------------------------------------------------
 
 This is likely due to one of our tools (i.e. ``black``) being upgraded. Within the

exasol/toolbox/nox/_format.py

@@ -52,7 +52,7 @@ def fix(session: Session) -> None:
     _code_format(session, Mode.Fix, py_files)
 
 
-@nox.session(name="project:format", python=False)
+@nox.session(name="format:check", python=False)
 def fmt_check(session: Session) -> None:
     """Checks the project for correct formatting"""
     py_files = python_files(PROJECT_CONFIG.root)

exasol/toolbox/templates/github/workflows/checks.yml

@@ -158,7 +158,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/python-environment@v3
 
       - name: Run format check
-        run: poetry run -- nox -s project:format
+        run: poetry run -- nox -s format:check
 
   Build-Packages:
     name: Build Package Check