michael-o commented on code in PR #19:
URL:
https://github.com/apache/maven-reporting-api/pull/19#discussion_r1379691836
##########
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()}
Review Comment:
@elharo, it is both. A path to a file. I need to rename the API to satisfy
this. I could do with a default interface method. The current name is just bad.
I am happy to accept any reformulation of the docs which make it better. Should
I raise a PR to rename the method and deprecate it? FWIW, it is not necessarily
a file name because it is free of a format. The plugin impl does not decide
about the format. It is a symbolic name in a virtual FS, so to speak.
--
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
