f docs

Author: TheBlueMatt

lightning/src/ln/functional_test_utils.rs

@@ -1381,6 +1381,7 @@ impl SendEvent {
 }
 
 #[macro_export]
+/// Don't use this, use the identically-named function instead.
 macro_rules! expect_pending_htlcs_forwardable_conditions {
 	($node: expr, $expected_failures: expr) => {
 		$crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions(&$node, &$expected_failures);
@@ -1402,6 +1403,9 @@ macro_rules! expect_htlc_handling_failed_destinations {
 	}}
 }
 
+/// Checks that an [`Event::PendingHTLCsForwardable`] is available on the given node and, if there
+/// are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
+/// `expected_failures` set.
 pub fn expect_pending_htlcs_forwardable_conditions(node: &Node, expected_failures: &[HTLCDestination]) {
 	let events = node.node.get_and_clear_pending_events();
 	match events[0] {
@@ -1419,6 +1423,9 @@ pub fn expect_pending_htlcs_forwardable_conditions(node: &Node, expected_failure
 
 #[macro_export]
 /// Clears (and ignores) a PendingHTLCsForwardable event
+///
+/// Don't use this, call [`expect_pending_htlcs_forwardable_conditions`] with an empty failure set
+/// instead.
 macro_rules! expect_pending_htlcs_forwardable_ignore {
 	($node: expr) => {
 		$crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions(&$node, &[]);
@@ -1427,6 +1434,8 @@ macro_rules! expect_pending_htlcs_forwardable_ignore {
 
 #[macro_export]
 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
+///
+/// Don't use this, call [`expect_pending_htlcs_forwardable_conditions`] instead.
 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
 	($node: expr, $expected_failures: expr) => {
 		$crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions(&$node, &$expected_failures);