Skip to content

Commit 09a5cd3

Browse files
committed
f tighten docs
1 parent 22201ed commit 09a5cd3

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

lightning/src/routing/router.rs

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1190,13 +1190,17 @@ pub struct FirstHopCandidate<'a> {
11901190
pub payer_node_id: &'a NodeId,
11911191
/// A unique ID which describes the payer.
11921192
///
1193-
/// It will not conflict with any [`super::gossip::NodeInfo::node_counter`]s, but may be equal
1194-
/// to one if the payer is a public node.
1193+
/// It will not conflict with any [`NodeInfo::node_counter`]s, but may be equal to one if the
1194+
/// payer is a public node.
1195+
///
1196+
/// [`NodeInfo::node_counter`]: super::gossip::NodeInfo::node_counter
11951197
pub(crate) payer_node_counter: u32,
11961198
/// A unique ID which describes the first hop counterparty.
11971199
///
1198-
/// It will not conflict with any [`super::gossip::NodeInfo::node_counter`]s, but may be equal
1199-
/// to one if the counterparty is a public node.
1200+
/// It will not conflict with any [`NodeInfo::node_counter`]s, but may be equal to one if the
1201+
/// counterparty is a public node.
1202+
///
1203+
/// [`NodeInfo::node_counter`]: super::gossip::NodeInfo::node_counter
12001204
pub(crate) target_node_counter: u32,
12011205
}
12021206

@@ -1226,13 +1230,17 @@ pub struct PrivateHopCandidate<'a> {
12261230
pub target_node_id: &'a NodeId,
12271231
/// A unique ID which describes the source node of the hop (further from the payment target).
12281232
///
1229-
/// It will not conflict with any [`super::gossip::NodeInfo::node_counter`]s, but may be equal
1230-
/// to one if the node is a public node.
1233+
/// It will not conflict with any [`NodeInfo::node_counter`]s, but may be equal to one if the
1234+
/// node is a public node.
1235+
///
1236+
/// [`NodeInfo::node_counter`]: super::gossip::NodeInfo::node_counter
12311237
pub(crate) source_node_counter: u32,
12321238
/// A unique ID which describes the destination node of the hop (towards the payment target).
12331239
///
1234-
/// It will not conflict with any [`super::gossip::NodeInfo::node_counter`]s, but may be equal
1235-
/// to one if the node is a public node.
1240+
/// It will not conflict with any [`NodeInfo::node_counter`]s, but may be equal to one if the
1241+
/// node is a public node.
1242+
///
1243+
/// [`NodeInfo::node_counter`]: super::gossip::NodeInfo::node_counter
12361244
pub(crate) target_node_counter: u32,
12371245
}
12381246

@@ -1256,9 +1264,10 @@ pub struct BlindedPathCandidate<'a> {
12561264
hint_idx: usize,
12571265
/// A unique ID which describes the introduction point of the blinded path.
12581266
///
1259-
/// It will not conflict with any [`super::gossip::NodeInfo::node_counter`]s, but will generally
1260-
/// be equal to one from the public network graph (assuming the introduction point is a public
1261-
/// node).
1267+
/// It will not conflict with any [`NodeInfo::node_counter`]s, but will generally be equal to
1268+
/// one from the public network graph (assuming the introduction point is a public node).
1269+
///
1270+
/// [`NodeInfo::node_counter`]: super::gossip::NodeInfo::node_counter
12621271
source_node_counter: u32,
12631272
}
12641273

@@ -1284,9 +1293,10 @@ pub struct OneHopBlindedPathCandidate<'a> {
12841293
hint_idx: usize,
12851294
/// A unique ID which describes the introduction point of the blinded path.
12861295
///
1287-
/// It will not conflict with any [`super::gossip::NodeInfo::node_counter`]s, but will generally
1288-
/// be equal to one from the public network graph (assuming the introduction point is a public
1289-
/// node).
1296+
/// It will not conflict with any [`NodeInfo::node_counter`]s, but will generally be equal to
1297+
/// one from the public network graph (assuming the introduction point is a public node).
1298+
///
1299+
/// [`NodeInfo::node_counter`]: super::gossip::NodeInfo::node_counter
12901300
source_node_counter: u32,
12911301
}
12921302

0 commit comments

Comments
 (0)