From bdce12b07e2a9327ae0ca5fc211b7efae9cb3edb Mon Sep 17 00:00:00 2001 From: Devin Ragotzy Date: Mon, 4 Oct 2021 16:05:11 -0400 Subject: [PATCH] state-res: Add some docs and fix a typo --- crates/ruma-events/src/room/join_rules.rs | 2 +- crates/ruma-state-res/src/lib.rs | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/crates/ruma-events/src/room/join_rules.rs b/crates/ruma-events/src/room/join_rules.rs index 2638ab40..fe4300d8 100644 --- a/crates/ruma-events/src/room/join_rules.rs +++ b/crates/ruma-events/src/room/join_rules.rs @@ -161,7 +161,7 @@ impl Restricted { #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)] #[serde(tag = "type")] pub enum AllowRule { - /// Joining is allowed if a user is already a member of the romm with the id `room_id`. + /// Joining is allowed if a user is already a member of the room with the id `room_id`. #[serde(rename = "m.room_membership")] RoomMembership(RoomMembership), diff --git a/crates/ruma-state-res/src/lib.rs b/crates/ruma-state-res/src/lib.rs index 0081456e..84a2bc3f 100644 --- a/crates/ruma-state-res/src/lib.rs +++ b/crates/ruma-state-res/src/lib.rs @@ -331,6 +331,10 @@ struct PowerLevelsContentFields { } /// Find the power level for the sender of `event_id` or return a default value of zero. +/// +/// Do NOT use this any where but topological sort, we find the power level for the eventId +/// at the eventId's generation (we walk backwards to `EventId`s most recent previous power level +/// event). fn get_power_level_for_sender( event_id: &EventId, fetch_event: impl Fn(&EventId) -> Option,