Skip to content

Commit 0fbc465

Browse files
committed
Apply changes per review
1 parent 521fc44 commit 0fbc465

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

doc/user_guide/features/metrics/collecting_metrics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ files and based on a selected external Python tool.
3030
| ``test:integration -- --coverage`` | ``.coverage`` | ``coverage`` |
3131
+------------------------------------+-----------------------------+--------------+
3232

33-
These metrics are computed for each point in your build matrix, e.g. for each
33+
These metrics are computed for each element in your build matrix, e.g. for each
3434
Python version defined in the file ``noxconfig.py``:
3535

3636
.. code-block:: python

doc/user_guide/features/metrics/project_report.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@
22

33
``project:report``
44
==================
5-
The nox session ``project:report`` provides an overall coverage percentage,
6-
maintainability grade, and security grade based on the :ref:`generated_metrics` collected.
7-
The definitions used for evaluating the quality of the Python code is defined in the
8-
`metrics.py`_ file, and the required fields are specified by the code-agnostic
9-
:ref:`metrics_schema` for Exasol. This nox session can return its analysis in two forms:
5+
After collecting the metrics described in by :ref:`generated_metrics`, you can use the
6+
nox session ``project:report`` to create a report using one of the following formats:
107

118
* JSON
12-
This directly meets the requirements for the :ref:`metrics_schema`. In our CI runs,
13-
a JSON is created & uploaded as an artifact, which can be downloaded later by the
14-
crawler project.
9+
This format is usually used in the CI. The created JSON file is uploaded as an
10+
artifact, which can be downloaded and aggregated for multiple projects
11+
(see :ref:`metrics_schema`).
1512
* markdown
16-
This is displayed in the GitHub Action's Summary for a given CI run. Displaying
13+
This is displayed in the GitHub Action's summary for a given CI run. Displaying
1714
this content per CI run gives the developer immediate feedback as to how the code
1815
quality has changed between code modifications.
1916

0 commit comments

Comments
 (0)