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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
