Skip to content

Commit

Permalink
Add some corrections to the documentation #2963
Browse files Browse the repository at this point in the history
  • Loading branch information
ValentinaA authored and ce-bo committed Feb 23, 2023
1 parent cd6a15e commit 840366f
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 12 deletions.
8 changes: 3 additions & 5 deletions gh-pages/_docs/06-05-suspicious-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
permalink: /docs/suspicious-metrics/
title: "Suspicious metrics"

This feature compares the values of different metrics with metric values of 241 Open Source Java projects.
This feature compares the values of certain metrics from the loaded cc.json file with metric values of 241Open Source Java projects.
Based on this data suspicious and inconspicuous metrics are identified and corresponding suggestions can be clicked to view them.

Be aware that metrics for other programming languages might not be comparable to Java Reference metric values.

To activate this function it is necessary to open the global configuration menu and activate the experimental features,
after that the Suspicious button will appear in the main menu. Pressing this button will open the suspicious metrics panel.
Here are listed the suspicious metrics, you can change the map view with the suspicious metrics buttons, you can also see
highlighted on the map the files with a high risk factor (if any).
The Suspicious button appears in the main menu. Pressing this button will open the suspicious metrics panel.
Listed you will find the suspicious metrics, clicking one of them highlights high-risk files directly on the map.
5 changes: 2 additions & 3 deletions gh-pages/_docs/06-06-risk-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ The Risk Profile gives a quick overview about the complexity and risk structure
of the code is placed in files associated with low/high risk in means of maintainability.

The separation of code in risk classes like low or high complexity is based on Java reference metric values and therefore
can be inaccurate for other programming languages.
may be inaccurate for other programming languages.

To activate this function it is necessary to open the global configuration menu and activate the experimental features,
after that the Risk profile button will appear in the main menu. Pressing this button will open the risk profile panel.
The Risk profile button appears in the main menu. Pressing this button will open the risk profile panel.
Here you will find listed the code percentages separated by their complexity.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div>
The Risk Profile gives a quick overview about the complexity and risk structure of the code base. It tells you how much of the
code is placed in files associated with low/high risk in means of maintainability. The separation of code in risk classes like
low or high complexity is based on Java reference metric values and therefore can be inaccurate for other programming languages.
low or high complexity is based on Java reference metric values and therefore may be inaccurate for other programming languages.
More information can be found here:
<a href="https://maibornwolff.github.io/codecharta/docs/risk-profile/">link</a> to How-To article.
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@
}}
</div>
<div class="suspicious-metric">
This feature compares the values of different metrics with metric values of 241 Open Source Java projects. Based on this data
suspicious and inconspicuous metrics are identified and corresponding suggestions can be clicked to view them. Be aware that
metrics for other programming languages might not be comparable to Java Reference metric values
This feature compares the values of certain metrics from the loaded cc.json file with metric values of 241Open Source Java
projects. Based on this data suspicious and inconspicuous metrics are identified and corresponding suggestions can be clicked to
view them. Be aware that metrics for other programming languages might not be comparable to Java Reference metric values. More
information can be found here:
<a href="https://maibornwolff.github.io/codecharta/docs/suspicious-metrics/">link</a> to How-To article.
</div>
<ul>
<li *ngFor="let unsuspiciousMetric of data.unsuspiciousMetrics">{{ unsuspiciousMetric }}</li>
Expand Down

0 comments on commit 840366f

Please sign in to comment.