improve comments

celestiaorg · Nov 26, 2024 · 39f2644 · 39f2644
1 parent 77053b7
commit 39f2644
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/pkg/appconsts/v1/app_consts.go b/pkg/appconsts/v1/app_consts.go
@@ -6,11 +6,12 @@ const (
 	Version              uint64 = 1
 	SquareSizeUpperBound int    = 128
 	SubtreeRootThreshold int    = 64
-	// Note: TimeoutPropose and TimeoutCommit weren't actually constants in v1,
-	// they were defaults for user-configurable timeouts. TODO: consider
-	// removing them from this package.
+	// TimeoutPropose wasn't a constant in v1, it was the default for a
+	// user-configurable timeout.
 	TimeoutPropose = time.Second * 10
-	TimeoutCommit  = time.Second * 11
+	// TimeoutCommit wasn't a constant in v1, it was the default for a
+	// user-configurable timeout.
+	TimeoutCommit = time.Second * 11
 	// UpgradeHeightDelay is the number of blocks after a quorum has been
 	// reached that the chain should upgrade to the new version. Assuming a
 	// block interval of 12 seconds, this is 7 days.

diff --git a/pkg/appconsts/v2/app_consts.go b/pkg/appconsts/v2/app_consts.go
@@ -6,11 +6,12 @@ const (
 	Version              uint64 = 2
 	SquareSizeUpperBound int    = 128
 	SubtreeRootThreshold int    = 64
-	// Note: TimeoutPropose and TimeoutCommit weren't actually constants in v1,
-	// they were defaults for user-configurable timeouts. TODO: consider
-	// removing them from this package.
+	// TimeoutPropose wasn't a constant in v2, it was the default for a
+	// user-configurable timeout.
 	TimeoutPropose = time.Second * 10
-	TimeoutCommit  = time.Second * 11
+	// TimeoutCommit wasn't a constant in v2, it was the default for a
+	// user-configurable timeout.
+	TimeoutCommit = time.Second * 11
 	// UpgradeHeightDelay is the number of blocks after a quorum has been
 	// reached that the chain should upgrade to the new version. Assuming a block
 	// interval of 12 seconds, this is 7 days.