alamb commented on code in PR #6852: URL: https://github.com/apache/arrow-rs/pull/6852#discussion_r1874491032
########## README.md: ########## @@ -82,6 +82,24 @@ versions approximately every 2 months. [`object_store`]: https://crates.io/crates/object_store +### Deprecation Policy + +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. + +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. + +```rust +#[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 Review Comment: As I am a native English speaker and the author it made sense to me but I don't have the right perspective to really answer this question Would something like this be easier to understand > For example, an API deprecated in `51.3.0` can be removed in `54.0.0` (or later) ? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
