Tweak phrasing in Blinded{Message,Payment}Path::advance_path_by_one docs.

valentinewallace · valentinewallace · commit 8eb334421646 · 2024-08-16T10:28:52.000-04:00
diff --git a/lightning/src/blinded_path/message.rs b/lightning/src/blinded_path/message.rs
@@ -345,7 +345,7 @@ pub(super) fn blinded_hops<T: secp256k1::Signing + secp256k1::Verification>(
 	utils::construct_blinded_hops(secp_ctx, pks, tlvs, session_priv)
 }
 
-/// Advance the blinded onion message path by one hop, so make the second hop into the new
+/// Advance the blinded onion message path by one hop, making the second hop into the new
 /// introduction node.
 ///
 /// Will only modify `path` when returning `Ok`.
diff --git a/lightning/src/blinded_path/payment.rs b/lightning/src/blinded_path/payment.rs
@@ -383,7 +383,7 @@ pub(super) fn blinded_hops<T: secp256k1::Signing + secp256k1::Verification>(
 	utils::construct_blinded_hops(secp_ctx, pks, tlvs, session_priv)
 }
 
-/// Advance the blinded onion payment path by one hop, so make the second hop into the new
+/// Advance the blinded onion payment path by one hop, making the second hop into the new
 /// introduction node.
 ///
 /// Will only modify `path` when returning `Ok`.

Original file line number	Diff line number	Diff line change
`@@ -345,7 +345,7 @@ pub(super) fn blinded_hops<T: secp256k1::Signing + secp256k1::Verification>(`
`345`	`345`	`utils::construct_blinded_hops(secp_ctx, pks, tlvs, session_priv)`
`346`	`346`	`}`
`347`	`347`
`348`		`-/// Advance the blinded onion message path by one hop, so make the second hop into the new`
	`348`	`+/// Advance the blinded onion message path by one hop, making the second hop into the new`
`349`	`349`	`/// introduction node.`
`350`	`350`	`///`
`351`	`351`	/// Will only modify `path` when returning `Ok`.
Original file line number	Diff line number	Diff line change
`@@ -383,7 +383,7 @@ pub(super) fn blinded_hops<T: secp256k1::Signing + secp256k1::Verification>(`
`383`	`383`	`utils::construct_blinded_hops(secp_ctx, pks, tlvs, session_priv)`
`384`	`384`	`}`
`385`	`385`
`386`		`-/// Advance the blinded onion payment path by one hop, so make the second hop into the new`
	`386`	`+/// Advance the blinded onion payment path by one hop, making the second hop into the new`
`387`	`387`	`/// introduction node.`
`388`	`388`	`///`
`389`	`389`	/// Will only modify `path` when returning `Ok`.