chore: improve doc comments

Signed-off-by: Gregory Hill <[email protected]>
interlay · Apr 12, 2023 · d1a0c62 · d1a0c62
1 parent 114791e
commit d1a0c62
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/bitcoin/src/electrs/mod.rs b/bitcoin/src/electrs/mod.rs
@@ -246,6 +246,9 @@ impl ElectrsClient {
         Ok(txs)
     }
 
+    /// Returns the *largest* payment to the `address` which is
+    /// greater than or equal to the specified `amount` and contains
+    /// an `OP_RETURN` output with `data`.
     pub(crate) async fn get_tx_for_op_return(
         &self,
         address: Address,

diff --git a/bitcoin/src/light/wallet.rs b/bitcoin/src/light/wallet.rs
@@ -353,7 +353,7 @@ impl Wallet {
             log::info!("Found utxo: {}", utxo.outpoint.txid);
 
             if prev_txid.contains(&utxo.outpoint.txid) {
-                // skip if trying to spend previous tx (RBF)
+                // skip if trying to spend from the tx we are replacing
                 continue;
             }