Skip to content

MTA-4775: Effort differs between applications depending on whether th… #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
3 changes: 3 additions & 0 deletions docs/cli-guide/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ include::topics/mta-review-reports.adoc[leveloffset=+1]
// Optimize {ProductShortName} Performance
include::topics/mta-optimize-performance.adoc[leveloffset=+1]

// Issues with reports
include::topics/issues-with-report.adoc[leveloffset=+1]

// Configure {ProductShortName} to Exclude Files and Packages
// include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2]

Expand Down
12 changes: 12 additions & 0 deletions docs/topics/issues-with-report.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Module included in the following assemblies:
//
// * docs/cli-guide/master.adoc

:_content-type: CONCEPT
[id="issues-with-report_{context}"]
= Issues with reports

Analysis precision is lower when the project cannot be built for whatever reasons. This lowering of precision can be caused by a number of factors;

Check failure on line 9 in docs/topics/issues-with-report.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsErrors] Use 'several' rather than 'a number of'. Raw Output: {"message": "[RedHat.TermsErrors] Use 'several' rather than 'a number of'.", "location": {"path": "docs/topics/issues-with-report.adoc", "range": {"start": {"line": 9, "column": 128}}}, "severity": "ERROR"}

* The lack of a proper build file, such as, a `pom.xml` or `build.gradle` file. For example, running {ProductFullName} on a project with an inaccessible parent `pom.xml` file may not result in a full analysis.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, I guess there is Unnecessary Comma "such as,"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kpunwatk - it would be acceptable with a comma or without. However, as it is going into a two-item list, i think it reads better as it gives emphasis to the pom.xl and gradle.file.

As this is the last remaining issue, are you ok for me to move it Release Pending, please?

Thanks

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completely ok for me, Thanks!
PR looks good to me!

* Compilation errors of one form or another.
Loading