update ruchei-sample docs

parrrate · Jun 15, 2024 · 728bcb3 · 728bcb3
1 parent bb4902c
commit 728bcb3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -48,7 +48,6 @@ pin-project = "1"
 ruchei-callback.workspace = true
 ruchei-extra.workspace = true
 ruchei-route.workspace = true
-# ruchei-sample.workspace = true
 
 futures-util.workspace = true
 linked-hash-map.workspace = true

diff --git a/internal/ruchei-sample/src/lib.rs b/internal/ruchei-sample/src/lib.rs
@@ -1,4 +1,4 @@
-//! Utility for debugging `ruchei`
+//! Ad hoc utility for debugging `ruchei`. Not thread safe
 
 use std::{
     pin::Pin,
@@ -22,12 +22,14 @@ impl Drop for Reset {
     }
 }
 
+/// Create an RAII guard for enabling sampling, resetting to previous value on drop
 pub fn enable() -> Reset {
     let value = sample();
     set(true);
     Reset(value)
 }
 
+/// Create an RAII guard for disabling sampling, resetting to previous value on drop
 pub fn disable() -> Reset {
     let value = sample();
     set(false);
@@ -72,6 +74,7 @@ pub fn start() {
     thread::spawn(run);
 }
 
+#[doc(hidden)]
 #[pin_project]
 pub struct Exclude<S>(#[pin] pub S);