summary refs log tree commit diff stats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorSoniEx2 <endermoneymod@gmail.com>2022-04-22 09:19:19 -0300
committerSoniEx2 <endermoneymod@gmail.com>2022-04-22 09:19:19 -0300
commit4d5699665e7ffdab8ce1729e330fe1092b8ddf15 (patch)
tree7ec3ca0a3cb459b212338c4b152c0cf03696ac3a /src/lib.rs
parent00018982e9cc14049422ee260f1f74ec2687b7b4 (diff)
Clean up HookHandle docs.
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs4
1 files changed, 3 insertions, 1 deletions
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>,