Skip to content

Commit

Permalink
Minor: improve the Deprecation / API health policy
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Dec 9, 2024
1 parent d3cfc45 commit b109ba3
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 5 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,8 @@ DataFusion enforces MSRV policy using a [MSRV CI Check](https://github.com/searc

## DataFusion API evolution policy

Public methods in Apache DataFusion are subject to evolve as part of the API lifecycle.
Deprecated methods will be phased out in accordance with the [policy](https://datafusion.apache.org/library-user-guide/api-health.html), ensuring the API is stable and healthy.
Public methods in Apache DataFusion evolve over time: while we try to maintain a
stable API, we also improve the API over time. As a result, we typically
deprecate methods before removing them, according to the [api health policy].

[api health policy]: https://datafusion.apache.org/library-user-guide/api-health.html
36 changes: 33 additions & 3 deletions docs/source/library-user-guide/api-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,41 @@

# API health policy

To maintain API health, developers must track and properly deprecate outdated methods.
DataFusion is used extensively as a library and has a large public API, thus it
is important that the API is well maintained. In general, we try to minimize
breaking API changes, but they are sometimes necessary.

When possible, rather than making breaking API changes, we prefer to deprecate
APIs to give users time to adjust to the changes.

## Breaking Changes

In general, a function is part of the public API if it appears on the [docs.rs page]

Breaking public API changes are those that *require* users to change their code
for it to compile, and are listed as "Major Changes" in the [SemVer
Compatibility Section of the cargo book]. Common examples of breaking changes:

- Adding new required parameters to a function (`foo(a: i32, b: i32)` -> `foo(a: i32, b: i32, c: i32)`)
- Removing a `pub` function
- Changing the return type of a function

When making breaking public API changes, please add the `api-change` label to
the PR so we can highlight the changes in the release notes.

[docs.rs page]: https://docs.rs/datafusion/latest/datafusion/index.html
[SemVer Compatibility Section of the cargo book]: https://doc.rust-lang.org/cargo/reference/semver.html#change-categories

## Deprecation Policy

When deprecating a method:

- clearly mark the API as deprecated and specify the exact DataFusion version in which it was deprecated.
- concisely describe the preferred API, if relevant
- Mark the API as deprecated using `#[deprecated`] and specify the exact DataFusion version in which it was deprecated
- Concisely describe the preferred API to help the user transition

The deprecated version is the next version which will be released after the
deprecation PR is merged. For example, if the next scheduled release `41.0.0`,
and a method is deprecated in a PR, the deprecated version will be `41.0.0`.

API deprecation example:

Expand Down

0 comments on commit b109ba3

Please sign in to comment.