comphead commented on code in PR #13849: URL: https://github.com/apache/datafusion/pull/13849#discussion_r1894138893
########## docs/source/library-user-guide/api-health.md: ########## @@ -69,3 +69,32 @@ For example: Deprecated methods will remain in the codebase for a period of 6 major versions or 6 months, whichever is longer, to provide users ample time to transition away from them. Please refer to [DataFusion releases](https://crates.io/crates/datafusion/versions) to plan ahead API migration + +## Migration Guidelines + +To ensure smooth upgrades and maintain application stability, the following guidelines must be followed for changes involving: + +- Public API changes +- Introducing deprecated methods +- Removal of obsolete methods Review Comment: Automatic deprecation doc generation sounds good. We can think of it later. I'm not sure about removing it completely as it tracks API evolution for the user. There would be always a balance between development work and migration support. From recent days we understood user migration is important for them -- 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-unsubscr...@datafusion.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
