From 3d0fba5768929d9200259cf7ee56d3cf132b5a90 Mon Sep 17 00:00:00 2001 From: winniehere Date: Thu, 5 Sep 2024 17:40:21 +0800 Subject: [PATCH] docs: fix function comments (#21555) --- collections/quad.go | 2 +- store/v2/db/rocksdb.go | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/collections/quad.go b/collections/quad.go index 5a9a971dfdbb..bd2844728360 100644 --- a/collections/quad.go +++ b/collections/quad.go @@ -367,7 +367,7 @@ func NewSuperPrefixedQuadRange[K1, K2, K3, K4 any](k1 K1, k2 K2) Ranger[Quad[K1, } } -// NewSuperPrefixedQuadRange provides a Range for all keys prefixed with the given +// NewSuperPrefixedQuadRange3 provides a Range for all keys prefixed with the given // first, second and third parts of the Quad key. func NewSuperPrefixedQuadRange3[K1, K2, K3, K4 any](k1 K1, k2 K2, k3 K3) Ranger[Quad[K1, K2, K3, K4]] { key := QuadSuperPrefix3[K1, K2, K3, K4](k1, k2, k3) diff --git a/store/v2/db/rocksdb.go b/store/v2/db/rocksdb.go index 5378de85e734..5ef7e64da4e7 100644 --- a/store/v2/db/rocksdb.go +++ b/store/v2/db/rocksdb.go @@ -22,16 +22,16 @@ var ( defaultReadOpts = grocksdb.NewDefaultReadOptions() ) -// RocksDB implements `corestore.KVStoreWithBatch` using RocksDB as the underlying storage engine. -// It is used for only store v2 migration, since some clients use RocksDB as +// RocksDB implements `corestore.KVStoreWithBatch`, using RocksDB as the underlying storage engine. +// It is only used for store v2 migration, since some clients use RocksDB as // the IAVL v0/v1 backend. type RocksDB struct { storage *grocksdb.DB } -// defaultRocksdbOptions, good enough for most cases, including heavy workloads. +// defaultRocksdbOptions is good enough for most cases, including heavy workloads. // 1GB table cache, 512MB write buffer(may use 50% more on heavy workloads). -// compression: snappy as default, need to -lsnappy to enable. +// compression: snappy as default, use `-lsnappy` flag to enable. func defaultRocksdbOptions() *grocksdb.Options { bbto := grocksdb.NewDefaultBlockBasedTableOptions() bbto.SetBlockCache(grocksdb.NewLRUCache(1 << 30))