crepererum commented on code in PR #551: URL: https://github.com/apache/arrow-rs-object-store/pull/551#discussion_r2564703076
########## src/lib.rs: ########## @@ -613,68 +618,32 @@ pub type DynObjectStore = dyn ObjectStore; /// Id type for multipart uploads. pub type MultipartId = String; -/// Universal API to multiple object store services. +/// Universal API for object store services. /// -/// For more convenience methods, check [`ObjectStoreExt`]. +/// See the [module-level documentation](crate) for a high level overview and +/// examples. See [`ObjectStoreExt`] for additional convenience methods. /// /// # Contract -/// This trait is meant as a contract between object store implementations -/// (e.g. providers, wrappers) and the `object_store` crate itself and is +/// This trait is a contract between object store _implementations_ +/// (e.g. providers, wrappers) and the `object_store` crate itself. It is /// intended to be the minimum API required for an object store. /// -/// The [`ObjectStoreExt`] acts as an API/contract between `object_store` -/// and the store users and provides additional methods that may be simpler to use but overlap -/// in functionality with [`ObjectStore`]. -/// -/// # Wrappers Review Comment: I think the wrappers section is still relevant. In fact NOT using the clippy lint is still a foot gun (#537 proofs that even `object_store` itself suffered from this and we had a wide range of cases at Influx too). -- 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]
