Clarify MsgpackUseNewTimeFormat

hashicorp · Oct 24, 2023 · d796549 · d796549
1 parent fa518ae
commit d796549
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/net_transport.go b/net_transport.go
@@ -160,10 +160,10 @@ type NetworkTransportConfig struct {
 	// the timeout by (SnapshotSize / TimeoutScale).
 	Timeout 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
 }