[GitHub] [arrow-datafusion] yjshen commented on issue #1927: Add content from design docs to datafusion site

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

yjshen commented on issue #1927:
URL: https://github.com/apache/arrow-datafusion/issues/1927#issuecomment-1072077913


   I agree the design docs are of great value for every developer; it helps us to get outlines quickly. 
   
   My only concern is the potential confusion when docs and actual implementations are out of sync. For example, the memory management doc I drafted previously is quite different from the current code. I gradually implement it, gather comments, and adapts according to reviews. The gap is growing through many follow-up PRs with new ideas or needs.
   
   I'm not aware of good practices of constantly syncing design docs and code. It might be challenging. But if someone has excellent thoughts or best practices on this, I'm willing to follow instructions and always keep docs updated to date from my side. It would ideally reflect the evolutionary flow of our practices and the driving reasons behind them.
   
   Thanks again for the efforts to make our community more developer-friendly.


-- 
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: github-unsubscribe@arrow.apache.org

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