tablecodec: correct comments mistake (pingcap#3122)

anywhy · Apr 24, 2017 · 1685dcb · 1685dcb
1 parent 8c51d4b
commit 1685dcb
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/tablecodec/bench_test.go b/tablecodec/bench_test.go
@@ -30,6 +30,7 @@ func BenchmarkEncodeEndKey(b *testing.B) {
 	}
 }
 
+// BenchmarkEncodeRowKeyWithPrefixNex tests the performance of encoding row key with prefixNext
 // PrefixNext() is slow than using EncodeRowKeyWithHandle.
 // BenchmarkEncodeEndKey-4		20000000	        97.2 ns/op
 // BenchmarkEncodeRowKeyWithPrefixNex-4	10000000	       121 ns/op

diff --git a/tablecodec/tablecodec.go b/tablecodec/tablecodec.go
@@ -495,15 +495,15 @@ func EncodeTablePrefix(tableID int64) kv.Key {
 	return key
 }
 
-// Record prefix is "t[tableID]_r".
+// appendTableRecordPrefix appends table record prefix  "t[tableID]_r".
 func appendTableRecordPrefix(buf []byte, tableID int64) []byte {
 	buf = append(buf, tablePrefix...)
 	buf = codec.EncodeInt(buf, tableID)
 	buf = append(buf, recordPrefixSep...)
 	return buf
 }
 
-// Index prefix is "t[tableID]_i".
+// appendTableIndexPrefix appends table index prefix  "t[tableID]_i".
 func appendTableIndexPrefix(buf []byte, tableID int64) []byte {
 	buf = append(buf, tablePrefix...)
 	buf = codec.EncodeInt(buf, tableID)

diff --git a/tablecodec/tablecodec_test.go b/tablecodec/tablecodec_test.go
@@ -33,6 +33,7 @@ var _ = Suite(&testTableCodecSuite{})
 
 type testTableCodecSuite struct{}
 
+// TestTableCodec  tests some functions in package tablecodec
 // TODO: add more tests.
 func (s *testTableCodecSuite) TestTableCodec(c *C) {
 	defer testleak.AfterTest(c)()