docs: Add comment to initConsensusProtocols (#5791)

algorand · Oct 23, 2023 · b18a78e · b18a78e
1 parent 40c16e5
commit b18a78e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/config/consensus.go b/config/consensus.go
@@ -788,6 +788,9 @@ func PreloadConfigurableConsensusProtocols(dataDirectory string) (ConsensusProto
 	return Consensus.Merge(configurableConsensus), nil
 }
 
+// initConsensusProtocols defines the consensus protocol values and how values change across different versions of the protocol.
+//
+// These are the only valid and tested consensus values and transitions. Other settings are not tested and may lead to unexpected behavior.
 func initConsensusProtocols() {
 	// WARNING: copying a ConsensusParams by value into a new variable
 	// does not copy the ApprovedUpgrades map.  Make sure that each new