Skip to content

Commit fbe9f47

Browse files
committed
Reference Router in ChannelManager docs
1 parent f114515 commit fbe9f47

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
//! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
1414
//! upon reconnect to the relevant peer(s).
1515
//!
16-
//! It does not manage routing logic (see [`find_route`] for that) nor does it manage constructing
16+
//! It does not manage routing logic (see [`Router`] for that) nor does it manage constructing
1717
//! on-chain transactions (it only monitors the chain to watch for any force-closes that might
1818
//! imply it needs to fail HTLCs/payments/channels it manages).
19-
//!
20-
//! [`find_route`]: crate::routing::router::find_route
2119
2220
use bitcoin::blockdata::block::BlockHeader;
2321
use bitcoin::blockdata::transaction::Transaction;
@@ -1745,14 +1743,12 @@ where
17451743
self.list_channels_with_filter(|_| true)
17461744
}
17471745

1748-
/// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1749-
/// to ensure non-announced channels are used.
1746+
/// Gets the list of usable channels, in random order. Useful as an argument to
1747+
/// [`Router::find_route`] to ensure non-announced channels are used.
17501748
///
17511749
/// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
17521750
/// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
17531751
/// are.
1754-
///
1755-
/// [`find_route`]: crate::routing::router::find_route
17561752
pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
17571753
// Note we use is_live here instead of usable which leads to somewhat confused
17581754
// internal/external nomenclature, but that's ok cause that's probably what the user

0 commit comments

Comments
 (0)