Add clearer docs to auth_check

This commit is contained in:
Devin Ragotzy 2021-01-12 08:29:39 -05:00
parent 47b19fdc15
commit 37bff47a8e

View File

@ -71,6 +71,9 @@ pub fn auth_types_for_event(
/// The `auth_events` that are passed to this function should be a state snapshot.
/// We need to know if the event passes auth against some state not a recursive collection
/// of auth_events fields.
///
/// ## Returns
/// This returns an `Error` only when serialization fails or some other fatal outcome.
pub fn auth_check<E: Event>(
room_version: &RoomVersionId,
incoming_event: &Arc<E>,