Somewhat fixed new doc strings

Author: Nicklas Warming Jacobsen

vendor/cipherstash-client/src/encryption/plaintext/from_conversion.rs

@@ -6,7 +6,9 @@ use rust_decimal::Decimal;
 use super::{Plaintext, PlaintextNullVariant};
 use crate::encryption::errors::TypeParseError;
 
+/// Trait for converting `Plaintext` to `Self`
 pub trait TryFromPlaintext: Sized {
+    /// Try to convert `value` to `Self`
     fn try_from_plaintext(value: &Plaintext) -> Result<Self, TypeParseError>;
 }
 
@@ -40,10 +42,15 @@ impl_try_from_plaintext! {
     String => Utf8Str
 }
 
+/// Blanket implementation of `Option<T>` for all `T` that implements `TryFromPlaintext`.
 impl<T> TryFromPlaintext for Option<T>
 where
     T: TryFromPlaintext + PlaintextNullVariant,
 {
+    /// Returns an error if the `Plaintext` variant of `value` and `<T as PlaintextNullVariant>::null()` doesn't match
+    /// or if `TryFromPlaintext::try_from_plaintext` returns an error.
+    /// Returns `None` if the inner `Option` in `value` is `None`
+    /// Returns `Ok(Some(Self))` if `Plaintext` value could successfully be converted
     fn try_from_plaintext(value: &Plaintext) -> Result<Self, TypeParseError> {
         match (value, T::null()) {
             // Return OK(None) if the inner value is None

vendor/cipherstash-client/src/encryption/plaintext/mod.rs

@@ -285,8 +285,9 @@ impl Plaintext {
     }
 }
 
+/// Trait that defines the `None` or `Null` `Plaintext` variant of the implementing type.
 pub trait PlaintextNullVariant {
-    /// Returns Self's corresponding Plaintext variant with None
+    /// Returns Self's corresponding `Plaintext` variant with None
     fn null() -> Plaintext;
 }
 
@@ -322,7 +323,7 @@ impl PlaintextNullVariant for &str {
 }
 
 /// Blanket implementation for all references
-/// where the referenced type is clonable and implements ToPlaintext.
+/// where the referenced type implements `ToPlaintext`.
 impl<T> PlaintextNullVariant for &T
 where
     T: PlaintextNullVariant,
@@ -332,8 +333,8 @@ where
     }
 }
 
-/// Blanket implementation for Option<T> where
-/// T implements ToPlaintext.
+/// Blanket implementation for `Option<T>` where
+/// `T` implements `PlaintextNullVariant`.
 impl<T> PlaintextNullVariant for Option<T>
 where
     T: PlaintextNullVariant,

vendor/cipherstash-client/src/encryption/plaintext/to_conversion.rs

@@ -2,10 +2,9 @@ use super::{Plaintext, PlaintextNullVariant};
 use chrono::{DateTime, NaiveDate, Utc};
 use rust_decimal::Decimal;
 
-/// This trait works as a proxy for implementing `From<T> for Plaintext`.
-/// TODO Bla bla blanket impl on Option<T> and implementing From<T> for generic container types
+/// Trait for converting `Self` into `Plaintext`
 pub trait ToPlaintext: super::PlaintextNullVariant {
-    /// Converts Self into Plaintext
+    /// Converts `Self` into `Plaintext`
     fn to_plaintext(self) -> Plaintext;
 }
 
@@ -41,7 +40,7 @@ impl ToPlaintext for &str {
 }
 
 /// Blanket implementation for all references
-/// where the referenced type is clonable and implements ToPlaintext.
+/// where the referenced type is clonable and implements `ToPlaintext`.
 impl<T> ToPlaintext for &T
 where
     T: ToPlaintext + Clone,
@@ -52,8 +51,8 @@ where
     }
 }
 
-/// Blanket implementation for Option<T> where
-/// T implements ToPlaintext.
+/// Blanket implementation for `Option<T>` where
+/// `T` implements `ToPlaintext`.
 impl<T> ToPlaintext for Option<T>
 where
     T: ToPlaintext,
@@ -68,8 +67,8 @@ where
     }
 }
 
-/// Blanket implementation of From<T> for all
-/// T that implements ToPlaintext
+/// Blanket implementation of `From<T>` for all
+/// `T` that implements `ToPlaintext`
 impl<T> From<T> for Plaintext
 where
     T: ToPlaintext,