Skip to content

Commit c7d8597

Browse files
committed
Switch from direct to generated metrics
1 parent 97d1177 commit c7d8597

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

doc/user_guide/features/metrics/collecting_metrics.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Collecting metrics
77
project_report
88
sonar
99

10-
.. _direct_metrics:
10+
.. _generated_metrics:
1111

12-
Direct metrics
13-
++++++++++++++
12+
Generated metrics
13+
+++++++++++++++++
1414

1515
The PTB allows you to collect various metrics on the quality of your project
1616
regarding Coverage, Security, and Static Code Analysis.
@@ -48,7 +48,7 @@ The GitHub workflows of your project can:
4848
Reporting metrics
4949
+++++++++++++++++
5050

51-
Currently, the PTB offers two methods to aggregate the :ref:`direct_metrics`
51+
Currently, the PTB offers two methods to aggregate the :ref:`generated_metrics`
5252
into a report:
5353

5454
#. the nox session ``project:report``
@@ -59,7 +59,7 @@ into a report:
5959
`Sonar <https://docs.sonarsource.com/sonarqube-server/latest/>`__. For further
6060
details, see :ref:`sonarqube_analysis`
6161

62-
Both of these reporting options require that the generated files from the :ref:`direct_metrics`
62+
Both of these reporting options require that the generated files from the :ref:`generated_metrics`
6363
are existing and in the expected formats. As we have metrics for different Python
6464
versions, we pass on the metrics associated with the Python version named first in
6565
attribute ``python_versions`` of class ``Config`` to the reporting metrics tools.

doc/user_guide/features/metrics/project_report.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
``project:report``
44
==================
55
The nox session ``project:report`` provides an overall coverage percentage,
6-
maintainability grade, and security grade based on the :ref:`direct_metrics` collected.
6+
maintainability grade, and security grade based on the :ref:`generated_metrics` collected.
77
The definitions used for evaluating the quality of the Python code is defined in the
88
`metrics.py`_ file, and the required fields are specified by the code-agnostic
99
:ref:`metrics_schema` for Exasol. This nox session can return its analysis in two forms:
@@ -22,7 +22,7 @@ The definitions used for evaluating the quality of the Python code is defined in
2222

2323
Metrics schema
2424
++++++++++++++
25-
The PTB supports the uniform json schema for metrics used by all projects
25+
The PTB supports the uniform json schema for metrics used by all projects
2626
of the Exasol Product Integration Team:
2727

2828
* `Exasol Schemas`_

0 commit comments

Comments
 (0)