Mention where get_templated_pdu_json is used

This commit is contained in:
Erik Johnston
2026-05-21 14:34:55 +01:00
parent aae2de1cf0
commit 894d223132
+1 -1
View File
@@ -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.