f - clean up docs

Author: jkczyz

lightning/src/ln/interactivetxs.rs

@@ -1878,26 +1878,28 @@ impl InteractiveTxConstructor {
 	}
 }
 
-/// Determine whether a change output should be added, and if yes, of what size,
-/// considering our given inputs & outputs, and intended contribution.
-/// Computes the fees, takes into account the fees and the dust limit.
+/// Determine whether a change output should be added, and if yes, of what size, considering our
+/// given inputs and outputs, and intended contribution. Takes into account the fees and the dust
+/// limit.
+///
 /// Three outcomes are possible:
 /// - Inputs are sufficient for intended contribution, fees, and a larger-than-dust change:
 ///   `Ok(Some(change_amount))`
 /// - Inputs are sufficient for intended contribution and fees, and a change output isn't needed:
 ///   `Ok(None)`
-/// - Inputs are not sufficent to cover contribution and fees:
+/// - Inputs are not sufficient to cover contribution and fees:
 ///   `Err(AbortReason::InsufficientFees)`
+///
 /// Parameters:
-/// * `is_initiator` - Whether we are the negotiation initiator or not (acceptor).
-/// * `our_contribution` - The sats amount we intend to contribute to the funding
-//    transaction being negotiated.
-/// * `funding_inputs` - List of our inputs. It does not include the shared input (if there is one).
-/// * `shared_input` - Optionally, the amount of the shared input, if there is one.
-/// * `shared_output_funding_script` - The script of the shared output.
-/// * `funding_outputs` - Our funding outputs.
-/// * `funding_feerate_sat_per_1000_weight` - Fee rate to be used.
-/// * `change_output_dust_limit` - The dust limit (in sats) to consider.
+/// - `is_initiator` - Whether we are the negotiation initiator or not (acceptor).
+/// - `our_contribution` - The sats amount we intend to contribute to the funding
+///   transaction being negotiated.
+/// - `funding_inputs` - List of our inputs. It does not include the shared input, if there is one.
+/// - `shared_input` - The locally owned amount of the shared input (in sats), if there is one.
+/// - `shared_output_funding_script` - The script of the shared output.
+/// - `funding_outputs` - Our funding outputs.
+/// - `funding_feerate_sat_per_1000_weight` - Fee rate to be used.
+/// - `change_output_dust_limit` - The dust limit (in sats) to consider.
 pub(super) fn calculate_change_output_value(
 	is_initiator: bool, our_contribution: u64,
 	funding_inputs: &Vec<(TxIn, TransactionU16LenLimited)>, shared_input: Option<u64>,