Skip to content

Commit a94ccd7

Browse files
remove Quality refs from docs (#2370)
* remove Quality refs from docs
1 parent 3a2841f commit a94ccd7

File tree

12 files changed

+48
-46
lines changed

12 files changed

+48
-46
lines changed

docs/faq/code-analysis/which-metrics-does-codacy-calculate.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ Codacy performs static code analysis and calculates code duplication, code compl
88

99
The following sections describe how Codacy calculates each supported metric and where you can see each metric on the Codacy UI:
1010

11-
- [Grade](#grade)
12-
- [Issues](#issues)
13-
- [Complexity](#complexity)
14-
- [Duplication](#duplication)
15-
- [Code coverage](#code-coverage)
11+
- [Which metrics does Codacy calculate?](#which-metrics-does-codacy-calculate)
12+
- [Grade](#grade)
13+
- [Issues](#issues)
14+
- [Complexity](#complexity)
15+
- [Duplication](#duplication)
16+
- [Code coverage](#code-coverage)
17+
- [See also](#see-also)
1618

1719
!!! note
1820
Depending on certain characteristics of your repository, such as the number of source code files and their size, Codacy may [apply limits to the code analysis](does-codacy-place-limits-on-the-code-analysis.md) that impact the calculation of the supported metrics.

docs/getting-started/integrating-codacy-with-intellij-ides.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integrating Codacy with IntelliJ IDEs
22

3-
The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension) is an open-source plugin for IntelliJ IDEs that lets you review the result of the Codacy analysis for a pull request, get the full list of problems found, and navigate to any Quality issue that you want to review and fix.
3+
The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension) is an open-source plugin for IntelliJ IDEs that lets you review the result of the Codacy analysis for a pull request, get the full list of problems found, and navigate to any issue that you want to review and fix.
44

55
!!! info "To use this plugin you need a [Codacy account](https://www.codacy.com/signup-codacy)"
66

@@ -12,15 +12,15 @@ The main view of the Codacy IntelliJ plugin provides a summary of the code quali
1212

1313
In the main view, you can find the following information:
1414

15-
- The **Quality status** of the pull request, either up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
15+
- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
1616

17-
- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab.
17+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab.
1818

19-
When this item is expanded, the number next to each file name is the total number of Quality issues that the pull request adds to that file.
19+
When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to that file.
2020

2121
- The **diff coverage** introduced by the pull request. The percentage next to each file name is the coverage variation for that file.
2222

23-
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
23+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
2424

2525
- Variations in **code complexity** introduced by the pull request.
2626

@@ -56,12 +56,12 @@ After completing these steps, the main view shows the result of the latest Codac
5656

5757
## Reviewing pull request issues
5858

59-
In the **Problems tool window**, Codacy displays the same Quality issues you find in the main view and lets you navigate to the exact line of code where the issue was found.
59+
In the **Problems tool window**, Codacy displays the same issues you find in the main view and lets you navigate to the exact line of code where the issue was found.
6060

6161
!!! note
6262
Code coverage, duplicates, and complexity aren't currently shown in the Problems tool window.
6363

64-
To review Quality issues:
64+
To review issues:
6565

6666
1. Open the file you want to review.
6767

docs/getting-started/integrating-codacy-with-visual-studio-code.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The [Codacy Visual Studio Code extension](https://github.com/codacy/codacy-vscode-extension) is an open-source project that enables developers to review directly in VS Code the result of Codacy analysis for the pull requests they’re working on.
44

5-
Use this extension to get the full list of problems found by Codacy for a pull request and navigate to any Quality issue that you want to review and fix.
5+
Use this extension to get the full list of problems found by Codacy for a pull request and navigate to any issue that you want to review and fix.
66

77
!!! info "To use this extension you need a [Codacy account](https://www.codacy.com/signup-codacy)"
88

@@ -20,11 +20,11 @@ The main view of the extension displays information about the code quality and c
2020

2121
The **Pull request status** tab displays the following information for the pull request of the currently checked-out branch:
2222

23-
- The **Quality status** of the pull request, either up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
23+
- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
2424

25-
- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in VS Code's Problems tab.
25+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in VS Code's Problems tab.
2626

27-
When this item is expanded, the number next to each file name is the total number of Quality issues that the pull request adds to or removes from that file. The number farther to the right, added by VS Code, is the total number of problems in that file, which may or may not be Quality issues from Codacy. If there are any Medium or Critical Quality issues, the file name is also highlighted in yellow (Medium) or red (Critical).
27+
When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to or removes from that file. The number farther to the right, added by VS Code, is the total number of problems in that file, which may or may not be issues from Codacy. If there are any Medium or Critical issues, the file name is also highlighted in yellow (Medium) or red (Critical).
2828

2929
![Important issues](./images/codacy-vscode-extension-important-issues.png)
3030

@@ -34,7 +34,7 @@ The **Pull request status** tab displays the following information for the pull
3434

3535
![Toggle inline coverage](./images/codacy-vscode-extension-inline-coverage.png)
3636

37-
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
37+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
3838

3939
- Variations in **code complexity** introduced by the pull request.
4040

@@ -48,23 +48,23 @@ The **Open Pull Requests** tab lists all open pull requests for the repository,
4848

4949
- Analyzing, if Codacy is analyzing the branch.
5050

51-
- Up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
51+
- Up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
5252

5353
- The author of the pull request.
5454

5555
- The source and target branches of the pull request.
5656

57-
- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app.
57+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app.
5858

59-
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
59+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
6060

6161
- Variations in **code complexity** introduced by the pull request. This is the same value you find on the [Pull request quality overview](../repositories/pull-requests.md#quality-overview) in the Codacy app.
6262

6363
### Analyzed branch tab
6464

6565
![Analyzed branch tab UI](images/codacy-vscode-extension-analyzed-branch-tab.png)
6666

67-
The **Analyzed Branch** tab appears if you switch to an analyzed branch that doesn't have an open pull request, such as the `main` or `master` branch. This tab shows an overview of the Quality issues found in that branch, grouped by recently added, introduced by the current user, issue category, and issue severity.
67+
The **Analyzed Branch** tab appears if you switch to an analyzed branch that doesn't have an open pull request, such as the `main` or `master` branch. This tab shows an overview of the issues found in that branch, grouped by recently added, introduced by the current user, issue category, and issue severity.
6868

6969
See [how to manage the analysis of your repository's branches](../repositories-configure/managing-branches.md).
7070

@@ -99,16 +99,16 @@ To see Codacy quality and coverage data for an open pull request, follow these s
9999

100100
1. Check out the pull request of interest. You can do it either manually or from the **Open Pull Requests** tab, by clicking the arrow button or using the contextual right-click menu.
101101

102-
After completing these steps, the main view shows the result of the latest Codacy analysis for the pull request. The VS Code Problems tab lists the Quality issues found.
102+
After completing these steps, the main view shows the result of the latest Codacy analysis for the pull request. The VS Code Problems tab lists the issues found.
103103

104104
## Reviewing pull request issues
105105

106-
In the **Problems tab**, Codacy displays the same Quality issues you find in the **Status tab** and lets you navigate to the exact line of code where the issue was found.
106+
In the **Problems tab**, Codacy displays the same issues you find in the **Status tab** and lets you navigate to the exact line of code where the issue was found.
107107

108108
!!! note
109109
Code coverage, duplicates, and complexity aren't currently shown in the Problems tab.
110110

111-
To review Quality issues:
111+
To review issues:
112112

113113
1. Open the **Problems tab** (use `Ctrl+Shift+M` on Windows/Linux or `Cmd+Shift+M` on macOS).
114114

docs/repositories-configure/adjusting-quality-gates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Depending on the result of applying the quality gate rules, Codacy updates the c
1414

1515
To access the quality gates, open your repository **Settings**, tab **Gates**.
1616

17-
![Quality gates](images/quality-settings-gates.png)
17+
![Gates](images/quality-settings-gates.png)
1818

1919
- **New issues are over:** Pull requests or commits are marked not up to standards if the number of issues introduced that have at least the specified severity level is higher than the set value.
2020
- **New security issues are over:** Pull requests or commits are marked not up to standards if the number of security issues introduced that have at least the specified severity level is higher than the set value.

docs/repositories-configure/adjusting-quality-goals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Adjust the **quality goals** to help you monitor the progress of the code quality in your repository dashboard, and configure which files Codacy considers complex or duplicated.
44

5-
Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#quality-evolution-chart) to help you monitor the progress and overall quality status of your repository.
5+
Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#evolution-chart) to help you monitor the progress and overall quality status of your repository.
66

77
To access the quality goals, open your repository **Settings**, tab **Goals**. The following screenshot displays the default configuration values:
88

9-
![Quality goals](images/quality-settings-goals.png)
9+
![Goals](images/quality-settings-goals.png)
1010

1111
- **Issues are over:** Defines the threshold displayed on the tab **Issues** of the quality evolution chart.
1212
- **Complexity is over:** Defines the threshold displayed on the tab **Complexity** of the quality evolution chart.

docs/repositories/commits.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ page_name: "commit"
33
file_name: "commits"
44
---
55

6-
# Quality Commits page
6+
# Commits page
77

8-
The **Quality Commits page** displays an overview of the commits in your repository, such as the analysis status and the code quality metrics for each commit. This allows you to monitor the evolution of the code quality per commit in your repository.
8+
The **Commits page** displays an overview of the commits in your repository, such as the analysis status and the code quality metrics for each commit. This allows you to monitor the evolution of the code quality per commit in your repository.
99

1010
By default, the page lists the commits on the main branch of your repository, but if you have [more than one branch enabled](../repositories-configure/managing-branches.md) you can use the drop-down list at the top of the page to display commits on other branches.
1111

docs/repositories/coverage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Quality Coverage page
1+
# Coverage page
22

3-
The **Quality Coverage page** displays the current code coverage information in your [enabled repository branches](../repositories-configure/managing-branches.md).
3+
The **Coverage page** displays the current code coverage information in your [enabled repository branches](../repositories-configure/managing-branches.md).
44

55
If your repository doesn't have coverage set up, you can learn more on how to [add coverage to your repository](../coverage-reporter/index.md).
66

docs/repositories/files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Quality Files page
1+
# Files page
22

3-
The **Quality Files page** displays the current code quality information for each analyzed file in your [enabled repository branches](../repositories-configure/managing-branches.md).
3+
The **Files page** displays the current code quality information for each analyzed file in your [enabled repository branches](../repositories-configure/managing-branches.md).
44

55
By default, the page lists the files on the main branch of your repository. However, if you have [more than one branch enabled](../repositories-configure/managing-branches.md), you can select other branches using the drop-down list at the top of the page.
66

@@ -36,7 +36,7 @@ The header of the file detail page displays the same code quality metrics as the
3636

3737
Depending on the available analysis information for the file, Codacy displays one or more of the following tabs:
3838

39-
- **Issues:** Shows the annotated source code on the left-hand side and the matching list of issues and issue distribution by severity on the right-hand side. Each listed issue includes the same information and options available on the [Quality Issues page](issues.md).
39+
- **Issues:** Shows the annotated source code on the left-hand side and the matching list of issues and issue distribution by severity on the right-hand side. Each listed issue includes the same information and options available on the [Issues page](issues.md).
4040

4141
![Issues for a file](images/files-issues.png)
4242

docs/repositories/issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Quality Issues page
1+
# Issues page
22

3-
The **Quality Issues page** lists all the issues that Codacy detected in your repository, including the severity level and category of each issue.
3+
The **Issues page** lists all the issues that Codacy detected in your repository, including the severity level and category of each issue.
44

55
By default, the page lists the issues on the main branch of your repository but if you have [more than one branch enabled](../repositories-configure/managing-branches.md) you can use the drop-down list at the top of the page to display issues on other branches.
66

docs/repositories/pull-requests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ page_name: "pull request"
33
file_name: "pull-requests"
44
---
55

6-
# Quality Pull Requests page
6+
# Pull Requests page
77

8-
The **Quality Pull Requests page** displays an overview of the pull requests in your repository, such as the analysis status and the code quality metrics for each pull request. This allows you to monitor the code quality of the work in progress in your repository.
8+
The **Pull Requests page** displays an overview of the pull requests in your repository, such as the analysis status and the code quality metrics for each pull request. This allows you to monitor the code quality of the work in progress in your repository.
99

1010
By default, the page lists open pull requests, but you can click the **Closed** tab at the top of the list to display the closed pull requests.
1111

0 commit comments

Comments
 (0)