You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/03/20 09:57:34 UTC

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

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


   I have never worked on a project where the design docs and code did not drift out of sync over time. I think it is inevitable. 
   
   The code always ends up being the final reference. I think best practice is:
   1.  Strive to document the code itself as much as possible (including examples)
   2. Document key points / design criteria or rationale (that might not be obvious from code or tests) in extended docstrings as well 
   
   


-- 
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