From 894d2231326f3a2b0ae7ffe2d138d70fb68d16a5 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 21 May 2026 14:34:55 +0100
Subject: [PATCH] Mention where get_templated_pdu_json is used

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

diff --git a/rust/src/events/mod.rs b/rust/src/events/mod.rs
index 9225ea84bc..680684028e 100644
--- a/rust/src/events/mod.rs
+++ b/rust/src/events/mod.rs
@@ -260,7 +260,7 @@ impl Event {
 
     /// Like [`Event::get_dict`], except strips fields like `signatures`,
     /// `hashes` and `unsigned` so that the result is suitable as a template for
-    /// creating new events.
+    /// creating new events. Used in make_{join,leave,knock} flows.
     fn get_templated_pdu_json<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>> {
         // Use get_dict but strip signatures, unsigned, and hashes — the
         // joining/leaving/knocking server will re-sign and recalculate hashes.