Copilot commented on code in PR #584:
URL: 
https://github.com/apache/arrow-rs-object-store/pull/584#discussion_r2632911102


##########
src/lib.rs:
##########
@@ -694,6 +694,48 @@ pub type MultipartId = String;
 ///
 /// To automatically detect this issue, use
 /// 
[`#[deny(clippy::missing_trait_methods)]`](https://rust-lang.github.io/rust-clippy/master/index.html#missing_trait_methods).
+///
+/// # Upgrade Guide for 0.13.0
+///
+/// Upgrading to object_store 0.13.0 from an earlier version typically 
involves:
+///
+/// 1. Add a `use` for [`ObjectStoreExt`] to solve the error
+///
+/// ```text
+/// error[E0599]: no method named `put` found for reference `&dyn 
object_store::ObjectStore` in the current scope
+///    --> datafusion/datasource/src/url.rs:993:14
+/// ```
+///
+/// 2. Remove any (now) redundant implementations (such as `ObjectStore::put`) 
 from any
+///   `ObjectStore` implementations to resolve the error
+///
+/// ```text
+/// error[E0407]: method `put` is not a member of trait `ObjectStore`
+///     --> datafusion/datasource/src/url.rs:1103:9
+///      |
+/// ```
+///
+/// 3. Convert `ObjectStore::delete` to [`ObjectStore::delete_stream`] (see 
documentation
+///    on that method for details and examples)
+///
+/// 4. Combine `ObjectStore::copy` and `ObjectStore::copy_if_not_exists` 
implementations into
+///    [`ObjectStore::copy_opts`] (see documentation on that method for 
details and examples)
+///
+/// 5. Update `object_store::Error::NotImplemented` to include the name of the 
missing method
+///
+/// For example, change instances of
+/// ```text
+/// object_store::Error::NotImplemented
+/// ```
+/// to
+/// ```
+///  object_store::Error::NotImplemented {
+///    operation: "put".to_string(),
+///    implementer: "RequestCountingObjectStore".to_string(),
+///  };
+/// ```
+///
+///

Review Comment:
   There's an extra blank line here (two consecutive empty doc comment lines). 
For consistency, consider removing one of the blank lines.
   ```suggestion
   
   ```



##########
src/lib.rs:
##########
@@ -694,6 +694,48 @@ pub type MultipartId = String;
 ///
 /// To automatically detect this issue, use
 /// 
[`#[deny(clippy::missing_trait_methods)]`](https://rust-lang.github.io/rust-clippy/master/index.html#missing_trait_methods).
+///
+/// # Upgrade Guide for 0.13.0
+///
+/// Upgrading to object_store 0.13.0 from an earlier version typically 
involves:
+///
+/// 1. Add a `use` for [`ObjectStoreExt`] to solve the error
+///
+/// ```text
+/// error[E0599]: no method named `put` found for reference `&dyn 
object_store::ObjectStore` in the current scope
+///    --> datafusion/datasource/src/url.rs:993:14
+/// ```
+///
+/// 2. Remove any (now) redundant implementations (such as `ObjectStore::put`) 
 from any
+///   `ObjectStore` implementations to resolve the error
+///
+/// ```text
+/// error[E0407]: method `put` is not a member of trait `ObjectStore`
+///     --> datafusion/datasource/src/url.rs:1103:9
+///      |
+/// ```
+///
+/// 3. Convert `ObjectStore::delete` to [`ObjectStore::delete_stream`] (see 
documentation
+///    on that method for details and examples)
+///
+/// 4. Combine `ObjectStore::copy` and `ObjectStore::copy_if_not_exists` 
implementations into
+///    [`ObjectStore::copy_opts`] (see documentation on that method for 
details and examples)
+///
+/// 5. Update `object_store::Error::NotImplemented` to include the name of the 
missing method
+///
+/// For example, change instances of
+/// ```text
+/// object_store::Error::NotImplemented
+/// ```
+/// to
+/// ```
+///  object_store::Error::NotImplemented {

Review Comment:
   There's an extra leading space before the code. The line should start with 
"///" immediately followed by the code without a leading space to maintain 
consistency with typical Rust doc formatting.
   ```suggestion
   /// object_store::Error::NotImplemented {
   ```



##########
src/lib.rs:
##########
@@ -694,6 +694,48 @@ pub type MultipartId = String;
 ///
 /// To automatically detect this issue, use
 /// 
[`#[deny(clippy::missing_trait_methods)]`](https://rust-lang.github.io/rust-clippy/master/index.html#missing_trait_methods).
+///
+/// # Upgrade Guide for 0.13.0
+///
+/// Upgrading to object_store 0.13.0 from an earlier version typically 
involves:
+///
+/// 1. Add a `use` for [`ObjectStoreExt`] to solve the error
+///
+/// ```text
+/// error[E0599]: no method named `put` found for reference `&dyn 
object_store::ObjectStore` in the current scope
+///    --> datafusion/datasource/src/url.rs:993:14
+/// ```
+///
+/// 2. Remove any (now) redundant implementations (such as `ObjectStore::put`) 
 from any

Review Comment:
   There's a double space between the closing parenthesis and "from". Should be 
a single space for consistency.
   ```suggestion
   /// 2. Remove any (now) redundant implementations (such as 
`ObjectStore::put`) from any
   ```



-- 
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]

Reply via email to