From 4d5699665e7ffdab8ce1729e330fe1092b8ddf15 Mon Sep 17 00:00:00 2001
From: SoniEx2 <endermoneymod@gmail.com>
Date: Fri, 22 Apr 2022 09:19:19 -0300
Subject: Clean up HookHandle docs.

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

(limited to 'src/lib.rs')

diff --git a/src/lib.rs b/src/lib.rs
index 3585031..3343fed 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -357,7 +357,9 @@ pub struct EventAttrs<'a> {
     _dummy: PhantomData<&'a ()>,
 }
 
-/// A hook handle, used to enable unhooking.
+/// A hook handle.
+///
+/// Likes to get caught on stuff. Unhooks when dropped.
 #[must_use = "Hooks must be stored somewhere and are automatically unhooked on Drop"]
 pub struct HookHandle<'ph, 'f> where 'f: 'ph {
     ph: LtPhPtr<'ph>,
-- 
cgit 1.4.1