From 221fce68e36bf1926e93180bd4467f42cb1774d6 Mon Sep 17 00:00:00 2001
From: HampusM <hampus@hampusmat.com>
Date: Sun, 14 May 2023 17:24:07 +0200
Subject: docs: add error docs to the ResultExt try_event function

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

diff --git a/src/lib.rs b/src/lib.rs
index c07e0a1..5235e54 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -31,6 +31,9 @@ pub trait DeserializeTagged: Sized + MaybeStatic
 pub trait ResultExt<Value, DeError>
 {
     /// Returns `Ok(None)` if `Err` is `DeserializerError::UnexpectedEvent`.
+    ///
+    /// # Errors
+    /// Returns `Err` if a `Deserializer` error occurs.
     fn try_event(self) -> Result<Option<Value>, DeserializerError<DeError>>;
 }
 
-- 
cgit v1.2.3-18-g5258