From 7c290253258b961cb90937c6e4ff32858ec480a9 Mon Sep 17 00:00:00 2001 From: Monadic Cat Date: Sun, 21 Apr 2024 08:19:32 -0500 Subject: [PATCH] add Errors doc section --- twilight-util/src/signature_validation.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/twilight-util/src/signature_validation.rs b/twilight-util/src/signature_validation.rs index 3679d44c915..22a12006082 100644 --- 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],