f - clarify docs

jkczyz · jkczyz · commit f854789987c8 · 2024-04-08T16:05:57.000-05:00
diff --git a/lightning/src/blinded_path/mod.rs b/lightning/src/blinded_path/mod.rs
@@ -153,7 +153,8 @@ impl BlindedPath {
 		}))
 	}
 
-	/// Returns the introduction [`NodeId`] of the blinded path, if found in the network graph.
+	/// Returns the introduction [`NodeId`] of the blinded path, if it is publicly reachable (i.e.,
+	/// it is found in the network graph).
 	pub fn public_introduction_node_id<'a>(
 		&self, network_graph: &'a ReadOnlyNetworkGraph
 	) -> Option<&'a NodeId> {

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,8 @@ impl BlindedPath {`
`153`	`153`	`}))`
`154`	`154`	`}`
`155`	`155`
`156`		- /// Returns the introduction [`NodeId`] of the blinded path, if found in the network graph.
	`156`	+ /// Returns the introduction [`NodeId`] of the blinded path, if it is publicly reachable (i.e.,
	`157`	`+ /// it is found in the network graph).`
`157`	`158`	`pub fn public_introduction_node_id<'a>(`
`158`	`159`	`&self, network_graph: &'a ReadOnlyNetworkGraph`
`159`	`160`	`) -> Option<&'a NodeId> {`