tustvold commented on code in PR #8: URL: https://github.com/apache/arrow-rs-object-store/pull/8#discussion_r2007247418
########## CONTRIBUTING.md: ########## @@ -200,3 +200,31 @@ OBJECT_STORE_BUCKET=test-bucket \ GOOGLE_SERVICE_ACCOUNT=/tmp/gcs.json \ cargo test -p object_store --features=gcp ``` + + +# Deprecation Guidelines + +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. + +To deprecate an API: + +- Mark the API as deprecated using `#[deprecated]` and specify the exact arrow-rs 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 (please +consult the list above). To mark the API as deprecated, use the +`#[deprecated(since = "...", note = "...")]` attribute. + +Foe example Review Comment: ```suggestion For example ``` ########## CONTRIBUTING.md: ########## @@ -200,3 +200,31 @@ OBJECT_STORE_BUCKET=test-bucket \ GOOGLE_SERVICE_ACCOUNT=/tmp/gcs.json \ cargo test -p object_store --features=gcp ``` + + +# Deprecation Guidelines + +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. + +To deprecate an API: + +- Mark the API as deprecated using `#[deprecated]` and specify the exact arrow-rs version in which it was deprecated Review Comment: ```suggestion - Mark the API as deprecated using `#[deprecated]` and specify the exact object_store version in which it was deprecated ``` -- 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]
