From d4801f78a7ae15b6d43d3ea5f843f2ed05389b13 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 21 May 2026 13:46:10 +0100
Subject: [PATCH] Docstring for type_state_key_tuple

---
 rust/src/events/formats/mod.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/rust/src/events/formats/mod.rs b/rust/src/events/formats/mod.rs
index 537a053da9..29f32ae55e 100644
--- a/rust/src/events/formats/mod.rs
+++ b/rust/src/events/formats/mod.rs
@@ -179,6 +179,8 @@ pub struct EventCommonFields {
 }
 
 impl EventCommonFields {
+    /// Helper method to check if the event is a state event and return the
+    /// tuple of `(type, state_key)` if so.
     fn type_state_key_tuple(&self) -> Option<(&str, &str)> {
         if let Some(state_key) = &self.state_key {
             Some((&self.type_, state_key))