jamesyfshao commented on pull request #5394:
URL: https://github.com/apache/incubator-pinot/pull/5394#issuecomment-661665986


   > @jamesyfshao can we take the discussion to the design doc? I had asked a 
few questions there, but they are not resolved yet. Please see my comments on 
the "New Interface" section.
   > 
   > 
https://docs.google.com/document/d/1SFFir7ByxCff-aVYxQeTHpNhPXeP5q7P4g_6O2iNGgU/edit
   
   Hi @mcvsubbu sorry for the late replies, a bit busy last week. I have 
addressed your comment in the design docs again. Please feel free to see if 
those comments need further clarification. 
   
   Sorry I didn't address them sooner mostly because I am trying to address the 
clarification issues in the code documentation instead of design docs. I have 
been spending a bit more efforts on making sure the method interface naming are 
clear and comments in the code are accurate because I feel it is always easier 
for future Pinot maintainer to understand the actual logic of codes by reading 
how it interacts with other components and comments in the codes vs finding a 
particular section that links in some external design docs. I also feel this 
feature is very new and expected to continue evolving within the foreseeable 
future. This means that designs of actual logics will continue to changes and 
comments in codes is most likely to be more up-to-date compared to a static 
design doc. These are my reasoning for trying to put more emphasis on the 
comments instead of listing all API interfaces in a design doc. 


----------------------------------------------------------------
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:
us...@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org

Reply via email to