alamb commented on code in PR #405: URL: https://github.com/apache/arrow-rs-object-store/pull/405#discussion_r2152716035
########## src/lib.rs: ########## @@ -587,19 +587,22 @@ pub type DynObjectStore = dyn ObjectStore; pub type MultipartId = String; /// Universal API to multiple object store services. +/// +/// For more convience methods, check [`ObjectStoreExt`]. +/// +/// # Contract +/// This trait is meant as a contract between object store implementations +/// (e.g. providers, wrappers) and the `object_store` crate itself. Review Comment: Is another key goal that `ObjectStore` is meant to be the minimal required API? If so perhaps we can add something like ```suggestion /// This trait is meant as a contract between object store implementations /// (e.g. providers, wrappers) and the `object_store` crate itself and is /// intended to be the minimum API required for an object store. ``` ########## src/lib.rs: ########## @@ -587,19 +587,22 @@ pub type DynObjectStore = dyn ObjectStore; pub type MultipartId = String; /// Universal API to multiple object store services. +/// +/// For more convience methods, check [`ObjectStoreExt`]. +/// +/// # Contract +/// This trait is meant as a contract between object store implementations +/// (e.g. providers, wrappers) and the `object_store` crate itself. +/// +/// The [`ObjectStoreExt`] acts as an API/contract between `object_store` +/// and the store users. Review Comment: ```suggestion /// and the store users and provides additional methods that may be simpler to use but overlap /// in functionality with `ObjectStore` ``` -- 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]
