From 37bff47a8e376b22b8116c19e820446f28860bfb Mon Sep 17 00:00:00 2001
From: Devin Ragotzy <devin.ragotzy@gmail.com>
Date: Tue, 12 Jan 2021 08:29:39 -0500
Subject: [PATCH] Add clearer docs to auth_check

---
 src/event_auth.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/event_auth.rs b/src/event_auth.rs
index 21b69515..bc87ec6f 100644
--- a/src/event_auth.rs
+++ b/src/event_auth.rs
@@ -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>,