Update collecting metrics a little; more to come in another PR

ArBridgeman · ArBridgeman · commit 861f5e9d5f6d · 2025-07-28T15:17:49.000+02:00
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -2,7 +2,7 @@
 
 ## Documentation
 
-* #504: Removed Issue Tracking & Style Guides
+* #504: Removed Issue Tracking & Style Guides, moved & updated "Create a release", moved & updated "Collecting metrics"
 
 ## Feature
 
diff --git a/doc/user_guide/features/collecting_metrics.rst b/doc/user_guide/features/collecting_metrics.rst
@@ -1,23 +1,25 @@
-Collecting Metrics
+Collecting metrics
 ==================
 
-PTB allows you to collect various metrics on the quality of your project
+The PTB allows you to collect various metrics on the quality of your project
 regarding Coverage, Security, and Static Code Analysis.
 
-For each metric, there is a dedicated nox task, generating one or multiple
+For each metric, there is a dedicated nox session, generating one or multiple
 files and based on a selected external Python tool.
 
-+-----------------------------+-----------------------------+--------------+
-| Nox Task                    | Generated Files             | Based on     |
-+=============================+=============================+==============+
-| ``lint:code``               | ``lint.txt``, ``lint.json`` | ``pylint``   |
-+-----------------------------+-----------------------------+--------------+
-| ``lint:security``           | ``.security.json``          | ``bandit``   |
-+-----------------------------+-----------------------------+--------------+
-| ``test:unit -- --coverage`` | ``.coverage``               | ``coverage`` |
-+-----------------------------+-----------------------------+--------------+
-
-The metrics are computed for each point in your build matrix, e.g. for each
++------------------------------------+-----------------------------+--------------+
+| Nox session                        | Generated files             | Based on     |
++====================================+=============================+==============+
+| ``lint:code``                      | ``lint.txt``, ``lint.json`` | ``pylint``   |
++------------------------------------+-----------------------------+--------------+
+| ``lint:security``                  | ``.security.json``          | ``bandit``   |
++------------------------------------+-----------------------------+--------------+
+| ``test:unit -- --coverage``        | ``.coverage``               | ``coverage`` |
++------------------------------------+-----------------------------+--------------+
+| ``test:integration -- --coverage`` | ``.coverage``               | ``coverage`` |
++------------------------------------+-----------------------------+--------------+
+
+These metrics are computed for each point in your build matrix, e.g. for each
 Python version defined in file ``noxconfig.py``:
 
 .. code-block:: python
@@ -31,5 +33,5 @@ The GitHub workflows of your project can:
 * Use a build matrix, e.g. using different Python versions as shown above
 * Define multiple test sessions, e.g. for distinguishing fast vs. slow or expensive tests.
 
-PTB combines the coverage data of all test sessions but using only the Python
+The PTB combines the coverage data of all test sessions of the Python
 version named first in attribute ``python_versions`` of class ``Config``.
diff --git a/doc/user_guide/features/creating_a_release.rst b/doc/user_guide/features/creating_a_release.rst
@@ -1,5 +1,5 @@
-Create a release
-================
+Creating a release
+==================
 
 Preparing a release
 +++++++++++++++++++
diff --git a/doc/user_guide/features/index.rst b/doc/user_guide/features/index.rst
@@ -6,8 +6,8 @@ Features
 .. toctree::
     :maxdepth: 2
 
-    create_a_release
     collecting_metrics
+    creating_a_release
 
 Uniform Project Layout
 ----------------------
