Docs improvements

[rust-lightning] / lightning / src / ln / mod.rs

diff --git a/lightning/src/ln/mod.rs b/lightning/src/ln/mod.rs
index bc28063145c84117ce44a0baf4391bd63472d66a..f328f6b9c163d497d7fd90ed9e2923593a3340b8 100644 (file)
--- a/lightning/src/ln/mod.rs
+++ b/lightning/src/ln/mod.rs
@@ -7,19 +7,7 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
-//! High level lightning structs and impls live here.
-//!
-//! You probably want to create a [`ChannelManager`], and a [`P2PGossipSync`] first.
-//! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to
-//! create/manage connections and call get_and_clear_pending_events after each action, handling
-//! them appropriately.
-//!
-//! When you want to open/close a channel or send a payment, call into your [`ChannelManager`] and
-//! when you want to learn things about the network topology (eg get a route for sending a payment),
-//! call into your [`P2PGossipSync`].
-//!
-//! [`ChannelManager`]: channelmanager::ChannelManager
-//! [`P2PGossipSync`]: crate::routing::gossip::P2PGossipSync
+//! Implementations of various parts of the Lightning protocol are in this module.
 
 #[cfg(any(test, feature = "_test_utils"))]
 #[macro_use]