[GitHub] [druid] kfaraz commented on pull request #14356: Minor cleanups from working on sampling bugfix

["kfaraz (via GitHub)" <gi...@apache.org>]

kfaraz commented on PR #14356:
URL: https://github.com/apache/druid/pull/14356#issuecomment-1569437726

   > Do you think the benefit of a slightly cleaner git history outweighs leaving non-functional cleanups like these up for another day? 
   
   Yeah, I am torn about it at times myself 🤷🏻 .
   
   > Personally, I feel any updates similar to this one benefit future developers more than a clean history,
   
   I would have to disagree on the benefit to developers aspect as anyone reading a typo can immediately make out the correct alternative. Had we been _rephrasing_ the javadocs to use better language or adding new info, it could have been beneficial.
   
   > we should encourage anyone to make similar updates. After all, what are the chances that the next person touching the codebase will catch the exact same thing?
   
   I agree that we should encourage these improvements, however small. I personally do tend to include these with my own changes. 
   
   But I prefer a slightly different approach of going about them. I would rather contributors (and even reviewers) read the comments, javadocs, logs, exceptions in and around the code which is being touched in the PR at hand. This practice ensures that any outdated info is updated (which is often the case with comments and javadocs) and is bound to catch any formatting/typo issues too as an added benefit.
   
   Let me know what you think.


-- 
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: commits-unsubscribe@druid.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org