Add comments to length_to_fee and weight_to_fee

paritytech · Jan 11, 2023 · 9767e6b · 9767e6b
1 parent 0ae8033
commit 9767e6b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/frame/transaction-payment/src/lib.rs b/frame/transaction-payment/src/lib.rs
@@ -607,10 +607,13 @@ where
 		}
 	}
 
+	/// Compute the length portion of a fee by invoking the configured `LengthToFee` impl.
 	pub fn length_to_fee(length: u32) -> BalanceOf<T> {
 		T::LengthToFee::weight_to_fee(&Weight::from_ref_time(length as u64))
 	}
 
+	/// Compute the unadjusted portion of the weight fee by invoking the configured `WeightToFee`
+	/// impl. Note that the input `weight` is capped by the maximum block weight before computation.
 	pub fn weight_to_fee(weight: Weight) -> BalanceOf<T> {
 		// cap the weight to the maximum defined in runtime, otherwise it will be the
 		// `Bounded` maximum of its data type, which is not desired.