elharo commented on code in PR #19:
URL:
https://github.com/apache/maven-reporting-api/pull/19#discussion_r1380023006
##########
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:
Specific actionable context is useful, but too much "business need" is just
wasted words. Common examples:
* in order to improve performance
* in order to improve customer service
* in order to better serve you
None of these actually explain anything. Here don't just say "to better
structure the report output" but explain how the report output structure is
changed, or say nothing at all. I don't know if this is accurate but something
like "to divide the report documents into separate subdirectories" would be
more concrete. "to better structure the report output" is not a user story and
does not explain the business value.
--
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
