kriegaex commented on code in PR #19:
URL:
https://github.com/apache/maven-reporting-api/pull/19#discussion_r1379470012
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -84,14 +86,17 @@ public interface MavenReport {
String getDescription(Locale locale);
/**
- * Set a new output directory. Useful for staging.
+ * Set a new shared base report output directory. This directory may
contain output of other
Review Comment:
@elharo: It adds the notion that not necesarily all reports end up directly
in that directory, but that they can also end up in a subdirectory. A base
directory is the flipside of the medal regarding the term subdirectory. Of
course, without the "base" prefix, that would still hold true, but like I said
in an earlier comment: Maximally terse descriptions are not always ideal from a
reader's perspective. BTW, the reader inevitably knows way less about the
meaning of parameters than the provider. She is also unlikely to read all
documentation, but only as little as possible to solve her problem or implement
her use case. I.e., she does not have the full context. And even if she does,
she is unlikely to remember all of it.
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
