chore: Minor docs updates (#216)

Includes minor clarifications on some doc comments.

Author: jan-auer

clients/rust/src/delete.rs

@@ -13,15 +13,15 @@ impl Session {
     }
 }
 
-/// A DELETE request builder.
+/// A [`delete`](Session::delete) request builder.
 #[derive(Debug)]
 pub struct DeleteBuilder {
     session: Session,
     key: String,
 }
 
 impl DeleteBuilder {
-    /// Sends the `DELETE` request.
+    /// Sends the delete request.
     pub async fn send(self) -> crate::Result<DeleteResponse> {
         self.session
             .request(reqwest::Method::DELETE, &self.key)

clients/rust/src/get.rs

@@ -45,7 +45,7 @@ impl fmt::Debug for GetResponse {
 }
 
 impl Session {
-    /// Requests the object with the given `key`.
+    /// Retrieves the object with the given `key`.
     pub fn get(&self, key: &str) -> GetBuilder {
         GetBuilder {
             session: self.clone(),
@@ -55,7 +55,7 @@ impl Session {
     }
 }
 
-/// A GET request builder.
+/// A [`get`](Session::get) request builder.
 #[derive(Debug)]
 pub struct GetBuilder {
     session: Session,
@@ -73,7 +73,7 @@ impl GetBuilder {
         self
     }
 
-    /// Sends the `GET` request.
+    /// Sends the get request.
     pub async fn send(self) -> crate::Result<Option<GetResponse>> {
         let response = self
             .session

clients/rust/src/put.rs

@@ -49,17 +49,17 @@ impl Session {
         }
     }
 
-    /// Creates a PUT request for a [`Bytes`]-like type.
+    /// Creates or replaces an object using a [`Bytes`]-like payload.
     pub fn put(&self, body: impl Into<Bytes>) -> PutBuilder {
         self.put_body(PutBody::Buffer(body.into()))
     }
 
-    /// Creates a PUT request with a stream.
+    /// Creates or replaces an object using a streaming payload.
     pub fn put_stream(&self, body: ClientStream) -> PutBuilder {
         self.put_body(PutBody::Stream(body))
     }
 
-    /// Creates a PUT request with an [`AsyncRead`] type.
+    /// Creates or replaces an object using an [`AsyncRead`] payload.
     pub fn put_read<R>(&self, body: R) -> PutBuilder
     where
         R: AsyncRead + Send + Sync + 'static,
@@ -69,7 +69,7 @@ impl Session {
     }
 }
 
-/// A PUT request builder.
+/// A [`put`](Session::put) request builder.
 #[derive(Debug)]
 pub struct PutBuilder {
     session: Session,
@@ -136,7 +136,7 @@ impl PutBuilder {
 // However, `IntoFuture` needs to define the resulting future as an associated type,
 // and "impl trait in associated type position" is not yet stable :-(
 impl PutBuilder {
-    /// Sends the built PUT request to the upstream service.
+    /// Sends the built put request to the upstream service.
     pub async fn send(self) -> crate::Result<PutResponse> {
         let method = match self.key {
             Some(_) => reqwest::Method::PUT,

objectstore-types/src/lib.rs

@@ -199,8 +199,8 @@ pub struct Metadata {
 
     /// The creation/last replacement time of the object, if known.
     ///
-    /// This is populated by the server when performing a POST or PUT request, i.e. when an object is
-    /// first created or when an existing object is overwritten.
+    /// This is set by the server every time an object is put, i.e. when objects are first created
+    /// and when existing objects are overwritten.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub time_created: Option<SystemTime>,