doc(relay-builder): specify that relay is shutdown automatically on drop

Signed-off-by: Yuki Kishimoto <[email protected]>

Author: yukibtc

crates/nostr-relay-builder/src/local/mod.rs

@@ -19,6 +19,8 @@ use crate::builder::RelayBuilder;
 use crate::error::Error;
 
 /// A local nostr relay
+///
+/// This is automatically shutdown when all instances/clones are dropped!
 #[derive(Debug, Clone)]
 pub struct LocalRelay {
     inner: AtomicDestructor<InnerLocalRelay>,

crates/nostr-relay-builder/src/mock.rs

@@ -14,6 +14,8 @@ use crate::error::Error;
 use crate::local::LocalRelay;
 
 /// A mock relay for (unit) tests.
+///
+/// Check [`LocalRelay`] for more details.
 #[derive(Debug, Clone)]
 pub struct MockRelay {
     local: LocalRelay,