From 9e28ee95e5b44d90641c3cb48c9ea8de07a434fe Mon Sep 17 00:00:00 2001
From: link2xt <link2xt@testrun.org>
Date: Wed, 22 Feb 2023 15:10:33 +0000
Subject: [PATCH] Document PeerstateChange

---
 src/peerstate.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/peerstate.rs b/src/peerstate.rs
index e7433f0f3..3de53ea35 100644
--- a/src/peerstate.rs
+++ b/src/peerstate.rs
@@ -688,6 +688,10 @@ pub(crate) async fn maybe_do_aeap_transition(
     Ok(())
 }
 
+/// Type of the peerstate change.
+///
+/// Changes to the peerstate are notified to the user via a message
+/// explaining the happened change.
 enum PeerstateChange {
     /// The contact's public key fingerprint changed, likely because
     /// the contact uses a new device and didn't transfer their key.