yanghua commented on issue #1504: [HUDI-780] Add junit 5 URL: https://github.com/apache/incubator-hudi/pull/1504#issuecomment-612297922 > @yanghua @xushiyan my style has been to only use javadocs when it warrants them. forced writing of trivial/obvious docs is not very helpful.. That said, public APIs should have detailed/accurate javadocs, test framework/utility classes should. Not sure if we want to burn cycles (and increase file lengths) just for sake of having javadocs.. > > I know this is subjective. but atleast goes with few books I have read in the past and what made sense to me.. We can also start a separate DISCUSS on this and defer.. @vinothchandar I think we all understand that sometimes class names or method names are inherently readable and they can be self-explanatory. Adding javadocs to some classes seems a bit redundant. My more consideration is: Constraint and standardization are conducive to the formation of good habits. Because the developers involved in the community are diverse. And many developers have a "lazy psychology", that is, without such constraints, they may rather not do it, not everyone has a good habit to think more. In fact, some test classes may be very simple and do not need to add a document description, but some classes may require, even some instructions and warnings. But once we do not enable tool inspection, many contributors will be reluctant to do this out of "lazy psychology". In order to enable tool inspection, then we must maintain the unity of the entire style. This is my practice in the Flink community.
---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
