From 69fbe65ac463caa11d819a78ebe48f0363ebe6f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Damir=20Jeli=C4=87?= <poljar@termina.org.uk>
Date: Thu, 20 Aug 2020 10:21:00 +0200
Subject: [PATCH] crypto: Add some docs for the cross signing keys handling
 method.

---
 matrix_sdk_crypto/src/machine.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/matrix_sdk_crypto/src/machine.rs b/matrix_sdk_crypto/src/machine.rs
index 9becc8ad..0ceeebde 100644
--- a/matrix_sdk_crypto/src/machine.rs
+++ b/matrix_sdk_crypto/src/machine.rs
@@ -499,6 +499,14 @@ impl OlmMachine {
         Ok(changed_devices)
     }
 
+    /// Handle the device keys part of a key query response.
+    ///
+    /// # Arguments
+    ///
+    /// * `response` - The keys query response.
+    ///
+    /// Returns a list of identities that changed. Changed here means either
+    /// they are new, one of their properties has changed or they got deleted.
     async fn handle_cross_singing_keys(
         &self,
         response: &get_keys::Response,