Clarify MsgpackUseNewTimeFormat

hashicorp · Oct 24, 2023 · f236267 · f236267
1 parent 2c1a1a6
commit f236267
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/config.go b/config.go
@@ -261,10 +261,10 @@ type Config struct {
 	// queue to apply the warning and max depth.
 	QueueCheckInterval time.Duration
 
-	// MsgpackUseNewTimeFormat is used to force the underlying msgpack codec to
-	// use the newer format of time.Time when encoding, used in versions <=0.5.5
-	// by default. Decoding is not affected, as all decoders know how to decode
-	// both formats.
+	// MsgpackUseNewTimeFormat when set to true, force the underlying msgpack
+	// codec to use the new format of time.Time when encoding (used in
+	// go-msgpack v1.1.5 by default). Decoding is not affected, as all
+	// go-msgpack v2.1.0+ decoders know how to decode both formats.
 	MsgpackUseNewTimeFormat bool
 }