add Errors doc section

twilight-rs · May 8, 2024 · 4dccad7 · 4dccad7
1 parent b1503b5
commit 4dccad7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/twilight-util/src/signature_validation.rs b/twilight-util/src/signature_validation.rs
@@ -98,6 +98,10 @@ impl Key {
     /// Validate a signature for a given message body, timestamp, and signing key.
     ///
     /// (This method is a duplicate of [`check_signature`].)
+    ///
+    /// # Errors
+    /// This will fail if the request being validated has an invalid signature, or if it
+    /// was given the wrong key.
     pub fn verify(
         &self,
         signature: &[u8],