add some comments

matrix-org · Jan 9, 2025 · f234c45 · f234c45
1 parent e8c1622
commit f234c45
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -297,6 +297,8 @@ impl From<LibolmPickleError> for DehydratedDeviceError {
             LibolmPickleError::PublicKey(e) => Self::PublicKey(e),
             LibolmPickleError::Decode(e) => Self::Decode(e),
             LibolmPickleError::Encode(e) => Self::Encode(e),
+            // Any other errors should not happen when we're dealing with
+            // dehydrated devices.
             _ => panic!("Unexpected libolm pickle error {}", err),
         }
     }

diff --git a/src/olm/account/mod.rs b/src/olm/account/mod.rs
@@ -453,6 +453,9 @@ impl Account {
     /// [`from_dehydrated_device`]) and decrypt the messages sent to the
     /// dehydrated device.
     ///
+    /// The account must be a newly-created account that does not have any Olm
+    /// sessions, since the dehydrated device format does not store sessions.
+    ///
     /// Returns the ciphertext and nonce.  `key` is a 256-bit (32-byte) key for
     /// encrypting the device.
     ///