Skip to content

Commit c2ce0ac

Browse files
committed
f update docs
1 parent 679795b commit c2ce0ac

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lightning-invoice/src/utils.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -512,8 +512,9 @@ fn _create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_has
512512
/// * Always select the channel with the highest inbound capacity per counterparty node
513513
/// * Prefer channels with capacity at least `min_inbound_capacity_msat` and where the channel
514514
/// `is_usable` (i.e. the peer is connected).
515-
/// * If any public channel exists, the returned `RouteHint`s will be empty, and the sender will
516-
/// need to find the path by looking at the public channels instead
515+
/// * If any public channel exists, only public [`RouteHint`]s will be returned,
516+
/// * If any public, announced channel exists, no [`RouteHint`]s will be returned, as the sender
517+
/// is expected to find the path by looking at the public channels instead.
517518
fn filter_channels<L: Deref>(
518519
channels: Vec<ChannelDetails>, min_inbound_capacity_msat: Option<u64>, logger: &L
519520
) -> Vec<RouteHint> where L::Target: Logger {

0 commit comments

Comments
 (0)