From 696b12c5ed62c6bf3b4ddb6c8bdfd063fba3e5c2 Mon Sep 17 00:00:00 2001 From: Lucas Soriano del Pino Date: Wed, 6 Sep 2023 15:15:54 +1000 Subject: [PATCH] chore(ln-dlc-node): Rework docstring --- crates/ln-dlc-node/src/node/dlc_channel.rs | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/crates/ln-dlc-node/src/node/dlc_channel.rs b/crates/ln-dlc-node/src/node/dlc_channel.rs index 5ba472b35..88fad91b7 100644 --- a/crates/ln-dlc-node/src/node/dlc_channel.rs +++ b/crates/ln-dlc-node/src/node/dlc_channel.rs @@ -62,11 +62,8 @@ where .await? } - /// Updates the dlc channel with the given contract input and triggers the `RenewOffer` dlc - /// message. - /// - /// Note, this is only initiating the protocol and is only finished once the finalize messages - /// are exchanged. + /// Proposes and update to the DLC channel based on the provided [`ContractInput`]. A + /// [`RenewOffer`] is sent to the counterparty, kickstarting the renew protocol. pub async fn propose_dlc_channel_update( &self, dlc_channel_id: &[u8; 32],