Document Output Reports code #2911
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
as noted in #2869
Codecov Report
@@ Coverage Diff @@
## master #2911 +/- ##
=========================================
Coverage 80.15% 80.15%
Complexity 2429 2429
=========================================
Files 421 421
Lines 7384 7384
Branches 1354 1354
=========================================
Hits 5919 5919
Misses 764 764
Partials 701 701
Continue to review full report at Codecov.
|
cortinico
approved these changes
Jul 31, 2020
| @@ -3,6 +3,10 @@ package io.github.detekt.report.txt | |||
| import io.gitlab.arturbosch.detekt.api.Detektion | |||
| import io.gitlab.arturbosch.detekt.api.OutputReport | |||
|
|
|||
| /** | |||
| * Contains rule violations in a plain text report similar to a log file. | |||
There was a problem hiding this comment.
Suggested change
| * Contains rule violations in a plain text report similar to a log file. | |
| * Contains rule violations and metrics in a plain text report similar to a log file. |
There was a problem hiding this comment.
This report only contains rule violations and no metrics. 😉
That's the reason for documenting the reports now.
| @@ -6,7 +6,8 @@ import io.gitlab.arturbosch.detekt.api.OutputReport | |||
| import io.gitlab.arturbosch.detekt.api.Severity | |||
|
|
|||
| /** | |||
| * Generates an XML report following the structure of a Checkstyle report. | |||
| * Contains rule violations in an XML format. The report follows the structure of a Checkstyle report. | |||
There was a problem hiding this comment.
Suggested change
| * Contains rule violations in an XML format. The report follows the structure of a Checkstyle report. | |
| * Contains rule violations and metrics in an XML format. The report follows the structure of a Checkstyle report. |
There was a problem hiding this comment.
This report only contains rule violations and no metrics. 😉
That's the reason for documenting the reports now.
BraisGabin
approved these changes
Jul 31, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
as noted in #2869