nit:docs

Author: G8XSU

src/util/mod.rs

@@ -1,4 +1,4 @@
-/// Contains [StorableBuilder] helper utility.
+/// Contains [`StorableBuilder`] helper utility.
 ///
-/// [StorableBuilder]: storable_builder::StorableBuilder
+/// [`StorableBuilder`]: storable_builder::StorableBuilder
 pub mod storable_builder;

src/util/storable_builder.rs

@@ -17,13 +17,13 @@ const CHACHA20_CIPHER_NAME: &'static str = "ChaCha20Poly1305";
 
 impl StorableBuilder {
 
-	/// Creates a [`Storable`] that can be serialized and stored as `value` in [PutObjectRequest].
+	/// Creates a [`Storable`] that can be serialized and stored as `value` in [`PutObjectRequest`].
 	///
 	/// Uses ChaCha20 for encrypting the `input` and Poly1305 for generating mac/tag.
 	///
 	/// Refer to docs on [`Storable`] for more information.
 	///
-	/// [PutObjectRequest]: crate::types::PutObjectRequest
+	/// [`PutObjectRequest`]: crate::types::PutObjectRequest
 	pub fn build(&self, input: Vec<u8>, version: i64) -> Storable {
 		let mut rng = ThreadRng::default();
 		let mut nonce = [0u8; 12];
@@ -44,10 +44,10 @@ impl StorableBuilder {
 		}
 	}
 
-	/// Deconstructs the provided [`Storable`] and returns constituent decrypted data and it's
-	/// corresponding version as stored at the time of [PutObjectRequest].
+	/// Deconstructs the provided [`Storable`] and returns constituent decrypted data and its
+	/// corresponding version as stored at the time of [`PutObjectRequest`].
 	///
-	/// [PutObjectRequest]: crate::types::PutObjectRequest
+	/// [`PutObjectRequest`]: crate::types::PutObjectRequest
 	pub fn deconstruct(&self, mut storable: Storable) -> io::Result<(Vec<u8>, i64)> {
 		let encryption_metadata = storable.encryption_metadata.unwrap();
 		let mut cipher = ChaCha20Poly1305::new(&self.data_encryption_key, &encryption_metadata.nonce, &[]);