diff --git a/README.md b/README.md index ca2ff38e149..a9b37119d27 100644 --- a/README.md +++ b/README.md @@ -82,11 +82,11 @@ versions approximately every 2 months. [`object_store`]: https://crates.io/crates/object_store -### Deprecation Policy +### Deprecation Guidelines -Minor releases may deprecate, but not remove APIs. Deprecating APIs allows the -Rust programs to still compile, but will generate compiler warnings. This gives -downstream crates time to migrate to non deprecated APIs prior to their removal. +Minor releases may deprecate, but not remove APIs. Deprecating APIs allows +downstream Rust programs to still compile, but generate compiler warnings. This +gives downstream crates time to migrate prior to API removal. All deprecated APIs are marked using the `#[deprecated]` attribute with both the first version they were deprecated in, and what new API to use instead. @@ -95,10 +95,12 @@ first version they were deprecated in, and what new API to use instead. #[deprecated(since = "51.0.0", note = "Use `date_part` instead")] ``` -Deprecated APIs will be kept for at least two major releases after they were -deprecated. For example, an API deprecated in `51.3.0` will not be removed until -at least `54.0.0`. Given the planned release schedule, this is typically between -6 and 9 months. +In general, deprecated APIs will be kept for at least two major releases after +they were deprecated (typically between 6 - 9 months later). For example, an API +deprecated in `51.3.0` can be removed in `54.0.0` (or later). Deprecated APIs +may be removed earlier or later than these guidelines at the discretion of the +maintainers. + ## Related Projects