Skip to content

Commit e70319f

Browse files
authored
Improve Deprecation Guidelines more (#13776)
* Improve deprecation guidelines more * prettier
1 parent 652b5a4 commit e70319f

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,10 @@ Note: If a Rust hotfix is released for the current MSRV, the MSRV will be update
138138

139139
DataFusion enforces MSRV policy using a [MSRV CI Check](https://github.com/search?q=repo%3Aapache%2Fdatafusion+rust-version+language%3ATOML+path%3A%2F%5ECargo.toml%2F&type=code)
140140

141-
## DataFusion API evolution policy
141+
## DataFusion API Evolution and Deprecation Guidelines
142142

143143
Public methods in Apache DataFusion evolve over time: while we try to maintain a
144144
stable API, we also improve the API over time. As a result, we typically
145-
deprecate methods before removing them, according to the [api health policy].
145+
deprecate methods before removing them, according to the [deprecation guidelines].
146146

147-
[api health policy]: https://datafusion.apache.org/library-user-guide/api-health.html
147+
[deprecation guidelines]: https://datafusion.apache.org/library-user-guide/api-health.html

docs/source/library-user-guide/api-health.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ APIs to give users time to adjust to the changes.
3131
In general, a function is part of the public API if it appears on the [docs.rs page]
3232

3333
Breaking public API changes are those that _require_ users to change their code
34-
for it to compile, and are listed as "Major Changes" in the [SemVer
34+
for it to compile and execute, and are listed as "Major Changes" in the [SemVer
3535
Compatibility Section of the cargo book]. Common examples of breaking changes:
3636

3737
- Adding new required parameters to a function (`foo(a: i32, b: i32)` -> `foo(a: i32, b: i32, c: i32)`)
@@ -57,11 +57,7 @@ version will be `44.0.0`.
5757

5858
[`cargo.toml`]: https://github.com/apache/datafusion/blob/main/Cargo.toml
5959

60-
To mark the API as deprecated, use the `#[deprecated]` attribute like this:
61-
62-
```rust
63-
#[deprecated(since = "...", note = "...")]
64-
```
60+
To mark the API as deprecated, use the `#[deprecated(since = "...", note = "...")]` attribute.
6561

6662
For example:
6763

0 commit comments

Comments
 (0)