Bukama commented on code in PR #581:
URL: https://github.com/apache/maven-jar-plugin/pull/581#discussion_r3743858937
##########
src/site/fml/faq.fml:
##########
@@ -28,9 +28,9 @@ under the License.
<question>Why is there no documentation for the archive
parameter?</question>
<answer>
<p>
- The archive parameter is a class that resides outside of this plugin,
- in the Maven Archiver component. You can find the documentation for
- Maven Archiver
+ The `archive` parameter is a class outside of this plugin. It is
Review Comment:
maybe add "for" so "for a class and maybe "not provided, but only used by
this plugin".?
Current it reads very weird that a parameter should be a class
##########
src/site/fml/faq.fml:
##########
@@ -28,9 +28,9 @@ under the License.
<question>Why is there no documentation for the archive
parameter?</question>
<answer>
<p>
- The archive parameter is a class that resides outside of this plugin,
- in the Maven Archiver component. You can find the documentation for
- Maven Archiver
+ The `archive` parameter is a class outside of this plugin. It is
+ part of the Maven Archiver component. Read the Maven Archiver
+ documentation
Review Comment:
```suggestion
documentation.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
