kriegaex commented on PR #255:
URL: 
https://github.com/apache/maven-javadoc-plugin/pull/255#issuecomment-1853879465

   > Rewrite Javadoc to clarify
   
   @elharo, if you did not notice by inspecting my PR: I just contributes 
something valueable, fixing two bugs within 30 minutes of seeing this code for 
the first time in my life. It is meant to be a minimally invasive change, not a 
structural refactoring of either code or javadoc. Hence, I kept wording and 
structure of the existing javadocs intact. Otherwise, I would have had to 
rewrite the javadocs for the whole class and maybe also for the rest of the 
module.
   
   FYI, I also checked whom you can ask what this javadoc means and why it was 
written that way: Vincent Siveton.
   
   There is a software craftsmanship principle which is often forgotten: to 
separate refactoring functional changes. This PR is about functional changes 
and not supposed to restructure the code or its documentation more than 
necessary to accomodate to the fact that I made one method more flexible by and 
additional parameter and use that method from the previously existing one in to 
avoid code duplication.


-- 
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

Reply via email to