Skip to content

Commit

Permalink
prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Dec 9, 2024
1 parent b109ba3 commit c9ba507
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,4 @@ 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
[api health policy]: https://datafusion.apache.org/library-user-guide/api-health.html
10 changes: 5 additions & 5 deletions docs/source/library-user-guide/api-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ 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]
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
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:

Expand All @@ -42,17 +42,17 @@ 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
[semver compatibility section of the cargo book]: https://doc.rust-lang.org/cargo/reference/semver.html#change-categories

## Deprecation Policy

When deprecating a method:

- Mark the API as deprecated using `#[deprecated`] and specify the exact DataFusion version in which it was deprecated
- 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`,
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 c9ba507

Please sign in to comment.