[GitHub] [flink] JingGe commented on pull request #17196: [HOTFIX][docs] fix sentence to make the description more clear.

[GitBox <gi...@apache.org>]

JingGe commented on pull request #17196:
URL: https://github.com/apache/flink/pull/17196#issuecomment-932735416


   > I don't think this _really_ improves the javadocs. By virtue of what a seek does isn't the "position" bit unnecessary?
   
   Thanks for the feedback. IMHO, javadocs is written more for the user and less for us. It is written to help the user understanding the purpose of the method as easier as possible. It took me quite a while to get the author' idea about what "seek past" really means. To be honest, I read the sentence a few times and finally figure out the missing info between the two continuous written verbs "seek" and "past" should be "to the position". Now the idea is why not just took us 1 minute to add this info to make the comment more user friendly and save every user's time a little bit who will read it. Please let me know your thoughts, thanks. 
   


-- 
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-unsubscribe@flink.apache.org

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