kriegaex commented on code in PR #19:
URL:
https://github.com/apache/maven-reporting-api/pull/19#discussion_r1379471594
##########
src/main/java/org/apache/maven/reporting/MavenReport.java:
##########
@@ -53,7 +53,9 @@ public interface MavenReport {
void generate(Sink sink, Locale locale) throws MavenReportException;
/**
- * Get the base name used to create report's output file(s).
+ * Get the output name denoting a base location relative to the {@link
#getReportOutputDirectory()}
+ * used to create the report's main output file. The base location may
contain path components
Review Comment:
@elharo, again I ask you to read that from a user's perspective. Users need
more context information than providers and profit from examples and
explanations that a provider might correctly deem redundant. A certain degree
of redundancy or context helps humans to understand things.
--
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
