From 2b5ca51f58f7cde2513ee02db55de6a931b3e8e3 Mon Sep 17 00:00:00 2001 From: comphead Date: Wed, 23 Oct 2024 09:07:19 -0700 Subject: [PATCH] Documentation: Add API deprecation policy --- docs/source/library-user-guide/api-health.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/source/library-user-guide/api-health.md b/docs/source/library-user-guide/api-health.md index 3f3e1a916362..943a370e8172 100644 --- a/docs/source/library-user-guide/api-health.md +++ b/docs/source/library-user-guide/api-health.md @@ -18,12 +18,14 @@ --> # API health policy -To maintain API health, developers must track and properly deprecate outdated methods. + +To maintain API health, developers must track and properly deprecate outdated methods. When deprecating a method: -- clearly mark the API as deprecated and specify the exact DataFusion version in which it was deprecated. + +- 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: +API deprecation example: ```rust #[deprecated(since = "41.0.0", note = "Use SessionStateBuilder")] @@ -33,4 +35,3 @@ API deprecation 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 -