Documentation: Add API deprecation policy #13083
Conversation
github-actions
bot
added
the
documentation
| under the License. | ||
| --> | ||
|
|
||
| # API health policy |
There was a problem hiding this comment.
I think we should also add a link to the main README as well -- perhaps something on https://github.com/apache/datafusion?tab=readme-ov-file#apache-datafusion?
There was a problem hiding this comment.
Sorry @alamb i'm not quite following
There was a problem hiding this comment.
I was thinking that since this policy is in its own file (not in the README) it is not visible to people when they open https://github.com/apache/datafusion
I think it would make it easier to find if we either put the policy directly in the https://github.com/apache/datafusion/blob/main/README.md file or if not left a link in that file that points here
There was a problem hiding this comment.
That totally makes sense
There was a problem hiding this comment.
Added small policy description and a link from README to the policy
| - clearly mark the API as deprecated and specify the exact DataFusion version in which it was deprecated. | ||
| - concisely describe the preferred API, if relevant | ||
|
|
||
| API deprecation example: |
Which issue does this PR close?
Closes #13077 .
Rationale for this change
DataFusion need to state the clear policy when the deprecated methods can be removed from the codebase to let the users enough time to migrate and keep the API hygiene
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?