doc(crypto): Improve the documentation for the encrypted Content serialization

Co-authored-by: Richard van der Hoff <[email protected]>
Signed-off-by: Damir Jelić <[email protected]>

Author: poljar

crates/matrix-sdk-crypto/src/olm/session.rs

@@ -157,12 +157,15 @@ impl Session {
         }
 
         impl EventType for Content<'_> {
-            // This is a bit of a hack, usually we just define the `EVENT_TYPE` and use the
-            // default implementation of `event_type()`, we can't do this here
+            // This is a bit of a hack: usually we just define the `EVENT_TYPE` and use the
+            // default implementation of `event_type()`. We can't do this here
             // because the event type isn't static.
             //
-            // So we just leave EVENT_TYPE out. This works because the serialization is
-            // using `event_type()` and this type is contained to this function.
+            // We have to provide `EVENT_TYPE` to conform to the `EventType` trait, but
+            // don't actually use it, so we just leave it empty.
+            //
+            // This works because the serialization uses `event_type()` and this type is
+            // contained to this function.
             const EVENT_TYPE: &'static str = "";
 
             fn event_type(&self) -> &str {

crates/matrix-sdk-crypto/src/types/events/olm_v1.rs

@@ -163,7 +163,7 @@ impl AnyDecryptedOlmEvent {
 
 /// An `m.olm.v1.curve25519-aes-sha2` decrypted to-device event.
 ///
-/// **Note**: This event will reserialize events lossy, unknown fields will be
+/// **Note**: This event will reserialize events lossily; unknown fields will be
 /// lost during deserialization.
 #[derive(Clone, Debug, Deserialize)]
 pub struct DecryptedOlmV1Event<C>