Merge pull request #4354 from howjmay/clear-comment

* Make comment more clear * fmt --------- Co-authored-by: Thibault Martinez <[email protected]>
iotaledger · Dec 11, 2024 · 6edd6cd · 6edd6cd
2 parents b45cbce + 432f8c4
commit 6edd6cd
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/crates/iota-protocol-config/src/lib.rs b/crates/iota-protocol-config/src/lib.rs
@@ -898,9 +898,10 @@ pub struct ProtocolConfig {
     /// version.
     random_beacon_dkg_version: Option<u64>,
 
-    /// The maximum serialised transaction size (in bytes) accepted by
-    /// consensus. That should be bigger than the `max_tx_size_bytes` with
-    /// some additional headroom.
+    /// The maximum serialized transaction size (in bytes) accepted by
+    /// consensus. `consensus_max_transaction_size_bytes` should include
+    /// space for additional metadata, on top of the `max_tx_size_bytes`
+    /// value.
     consensus_max_transaction_size_bytes: Option<u64>,
     /// The maximum size of transactions included in a consensus block.
     consensus_max_transactions_in_block_bytes: Option<u64>,