util: add comments to describe fields of RowData

Signed-off-by: zyguan <zhongyangguan@gmail.com>
pingcap · Apr 18, 2023 · 7cd304d · 7cd304d
1 parent 6e8fdf8
commit 7cd304d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/util/rowcodec/common.go b/util/rowcodec/common.go
@@ -259,7 +259,10 @@ func (c ColData) Encode(buf []byte) ([]byte, error) {
 
 // RowData is a list of ColData for row checksum calculation.
 type RowData struct {
+	// Cols is a list of ColData which is expected to be sorted by id before calling Encode/Checksum.
 	Cols []ColData
+	// Data stores the result of Encode. However, it mostly acts as a buffer for encoding columns on checksum
+	// calculation.
 	Data []byte
 }