[maven-dependency-analyzer] branch elharo-patch-1 created (now 45e8ee7)

[el...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a change to branch elharo-patch-1
in repository https://gitbox.apache.org/repos/asf/maven-dependency-analyzer.git.


      at 45e8ee7  docs: rewrite for clarity

This branch includes the following new commits:

     new 45e8ee7  docs: rewrite for clarity

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[maven-dependency-analyzer] 01/01: docs: rewrite for clarity

[el...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch elharo-patch-1
in repository https://gitbox.apache.org/repos/asf/maven-dependency-analyzer.git

commit 45e8ee7703794215e876e479311d17233f7054b4
Author: Elliotte Rusty Harold <el...@users.noreply.github.com>
AuthorDate: Sun Mar 22 07:36:52 2020 -0400

    docs: rewrite for clarity
    
    @hboutemy
---
 src/site/apt/index.apt.vm | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 00bb245..06da15c 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -30,11 +30,12 @@ ${project.name}
 
   Analyzes the dependencies of a project for undeclared or unused artifacts.
 
-  <<Warning>>: Analysis is not done at source but bytecode level, then some cases are not detected
-  (constants, annotations with source-only retention, links in javadoc) which can lead to wrong result
-  if they are the only use of a dependency.
+  <<Warning>>: Because analysis is done on the bytecode rather than the source,
+  some cases are not detected including constants, annotations with source-only retention, 
+  and links in javadoc. This can lead to incorrect results when these are the only uses
+  of a dependency.
 
-  Main component is <<<ProjectDependencyAnalyzer>>>
+  The main component is <<<ProjectDependencyAnalyzer>>>
   ({{{./apidocs/org/apache/maven/shared/dependency/analyzer/ProjectDependencyAnalyzer.html}javadoc}}), which uses
   <<<ClassAnalyzer>>>
   ({{{./apidocs/org/apache/maven/shared/dependency/analyzer/ClassAnalyzer.html}javadoc}})